cloud_connectors

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

Overview

Name	cloud_connectors
Type	Resource
Id	azure.hybrid_cloud.cloud_connectors

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting cloud connector 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 connector.
tags	object	Resource tags.

list_by_resource_group

Request successful. The operation returns a list of cloud connectors 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 connector.
tags	object	Resource tags.

list_by_subscription

Request successful. The operation returns a list of cloud connector 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 connector.
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, cloudConnectorName		Gets the specified cloud connector in a specified resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName		Return list of cloud connectors in a resource group.
list_by_subscription	select	subscriptionId		Return list of cloud connectors in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, cloudConnectorName		Creates or updates a cloud connector resource.
delete	delete	subscriptionId, resourceGroupName, cloudConnectorName		Deletes a specified cloud connector resource.
update_tags	exec	subscriptionId, resourceGroupName, cloudConnectorName		Updates the specified cloud connector tags.
discover_resources	exec	subscriptionId, resourceGroupName, cloudConnectorName		Returns a list of discovered remote cloud resources via this cloud connector resource.

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
cloudConnectorName	string	The name of the cloud connector 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 connector in a specified resource group.

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

list_by_resource_group

Return list of cloud connectors in a resource group.

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

list_by_subscription

Return list of cloud connectors in a subscription.

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

INSERT examples

create_or_update

Creates or updates a cloud connector resource.

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

Manifest

# Description fields are for documentation purposes
- name: cloud_connectors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the cloud_connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_connectors resource.
    - name: cloudConnectorName
      value: string
      description: Required parameter for the cloud_connectors resource.
    - name: properties
      value: object
      description: |
        Properties of the cloud connector.
    - 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 connector resource.

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

Lifecycle Methods

update_tags

Updates the specified cloud connector tags.

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

discover_resources

Returns a list of discovered remote cloud resources via this cloud connector resource.

EXEC azure.hybrid_cloud.cloud_connectors.discover_resources 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudConnectorName='{{ cloudConnectorName }}' --required
;