cloud_connections

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

Overview

Name	cloud_connections
Type	Resource
Id	azure.hybrid_cloud.cloud_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting cloud connection resource.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	Properties of the cloud connection.
tags	object	Resource tags.

list_by_resource_group

Request successful. The operation returns a list of cloud connections resources.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	Properties of the cloud connection.
tags	object	Resource tags.

list_by_subscription

Request successful. The operation returns a list of cloud connection resources.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	Properties of the cloud connection.
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, cloudConnectionName		Gets the specified cloud connection in a specified resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName		Return list of cloud connections in a resource group.
list_by_subscription	select	subscriptionId		Return list of cloud connections in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, cloudConnectionName		Creates or updates a cloud connection resource
delete	delete	subscriptionId, resourceGroupName, cloudConnectionName		Deletes a specified cloud connection resource.
update_tags	exec	subscriptionId, resourceGroupName, cloudConnectionName		Updates the specified cloud connection tags.

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
cloudConnectionName	string	The name of the cloud connection resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified cloud connection in a specified resource group.

SELECT
etag,
location,
properties,
tags
FROM azure.hybrid_cloud.cloud_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudConnectionName = '{{ cloudConnectionName }}' -- required
;

list_by_resource_group

Return list of cloud connections in a resource group.

SELECT
etag,
location,
properties,
tags
FROM azure.hybrid_cloud.cloud_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Return list of cloud connections in a subscription.

SELECT
etag,
location,
properties,
tags
FROM azure.hybrid_cloud.cloud_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a cloud connection resource

INSERT INTO azure.hybrid_cloud.cloud_connections (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
cloudConnectionName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ cloudConnectionName }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cloud_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the cloud_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_connections resource.
    - name: cloudConnectionName
      value: string
      description: Required parameter for the cloud_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the cloud connection.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes a specified cloud connection resource.

DELETE FROM azure.hybrid_cloud.cloud_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudConnectionName = '{{ cloudConnectionName }}' --required
;

Lifecycle Methods

update_tags

Updates the specified cloud connection tags.

EXEC azure.hybrid_cloud.cloud_connections.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudConnectionName='{{ cloudConnectionName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;