Skip to main content

cloud_services_networks

Creates, updates, deletes, gets or lists a cloud_services_networks resource.

Overview​

Namecloud_services_networks
TypeResource
Idazure_extras.network_cloud.cloud_services_networks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
additionalEgressEndpointsarrayThe list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.
associatedResourceIdsarrayThe list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterIdstringThe resource ID of the Network Cloud cluster this cloud services network is associated with.
detailedStatusstringThe more detailed status of the cloud services network. Known values are: "Error", "Available", and "Provisioning". (Error, Available, Provisioning)
detailedStatusMessagestringThe descriptive message about the current detailed status.
enableDefaultEgressEndpointsstringThe indicator of whether the platform default endpoints are allowed for the egress traffic. Known values are: "True" and "False". (True, False)
enabledEgressEndpointsarrayThe full list of additional and default egress endpoints that are currently enabled.
etagstring"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocationobjectThe extended location of the resource. This property is required when creating the resource. Required.
hybridAksClustersAssociatedIdsarrayField Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.
interfaceNamestringThe name of the interface that will be present in the virtual machine to represent this network.
locationstringThe geo-location where the resource lives. Required.
provisioningStatestringThe provisioning state of the cloud services network. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
storageOptionsobjectThe storage options for the cloud services network.
storageStatusobjectThe storage status for the cloud services network.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociatedIdsarrayField Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, cloud_services_network_name, subscription_idGet properties of the provided cloud services network.
list_by_resource_groupselectresource_group_name, subscription_id$top, $skipTokenGet a list of cloud services networks in the provided resource group.
list_by_subscriptionselectsubscription_id$top, $skipTokenGet a list of cloud services networks in the provided subscription.
create_or_updateinsertresource_group_name, cloud_services_network_name, subscription_id, location, extendedLocationCreate a new cloud services network or update the properties of the existing cloud services network.
updateupdateresource_group_name, cloud_services_network_name, subscription_idUpdate properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.
create_or_updatereplaceresource_group_name, cloud_services_network_name, subscription_id, location, extendedLocationCreate a new cloud services network or update the properties of the existing cloud services network.
deletedeleteresource_group_name, cloud_services_network_name, subscription_idDelete the provided cloud services network.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
cloud_services_network_namestringThe name of the cloud services network. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
$skipTokenstringThe opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$topintegerThe maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples​

Get properties of the provided cloud services network.

SELECT
id,
name,
additionalEgressEndpoints,
associatedResourceIds,
clusterId,
detailedStatus,
detailedStatusMessage,
enableDefaultEgressEndpoints,
enabledEgressEndpoints,
etag,
extendedLocation,
hybridAksClustersAssociatedIds,
interfaceName,
location,
provisioningState,
storageOptions,
storageStatus,
systemData,
tags,
type,
virtualMachinesAssociatedIds
FROM azure_extras.network_cloud.cloud_services_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_services_network_name = '{{ cloud_services_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a new cloud services network or update the properties of the existing cloud services network.

INSERT INTO azure_extras.network_cloud.cloud_services_networks (
tags,
location,
properties,
extendedLocation,
resource_group_name,
cloud_services_network_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ cloud_services_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.

UPDATE azure_extras.network_cloud.cloud_services_networks
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_services_network_name = '{{ cloud_services_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples​

Create a new cloud services network or update the properties of the existing cloud services network.

REPLACE azure_extras.network_cloud.cloud_services_networks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_services_network_name = '{{ cloud_services_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Delete the provided cloud services network.

DELETE FROM azure_extras.network_cloud.cloud_services_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloud_services_network_name = '{{ cloud_services_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;