cloud_services_networks

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

Overview

Name	cloud_services_networks
Type	Resource
Id	azure.nexus.cloud_services_networks

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: CloudServicesNetworkProperties represents properties of the cloud services network.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: CloudServicesNetworkProperties represents properties of the cloud services network.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: CloudServicesNetworkProperties represents properties of the cloud services network.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, cloudServicesNetworkName		Get properties of the provided cloud services network.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of cloud services networks in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of cloud services networks in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, cloudServicesNetworkName, data__extendedLocation		Create a new cloud services network or update the properties of the existing cloud services network.
update	update	subscriptionId, resourceGroupName, cloudServicesNetworkName		Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, cloudServicesNetworkName		Delete 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.

Name	Datatype	Description
cloudServicesNetworkName	string	The name of the cloud services network.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get properties of the provided cloud services network.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.cloud_services_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudServicesNetworkName = '{{ cloudServicesNetworkName }}' -- required
;

list_by_resource_group

Get a list of cloud services networks in the provided resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.cloud_services_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of cloud services networks in the provided subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.cloud_services_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.nexus.cloud_services_networks (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
cloudServicesNetworkName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ cloudServicesNetworkName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cloud_services_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cloud_services_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_services_networks resource.
    - name: cloudServicesNetworkName
      value: string
      description: Required parameter for the cloud_services_networks resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

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.nexus.cloud_services_networks
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudServicesNetworkName = '{{ cloudServicesNetworkName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided cloud services network.

DELETE FROM azure.nexus.cloud_services_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudServicesNetworkName = '{{ cloudServicesNetworkName }}' --required
;