public_cloud_connectors

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

Overview

Name	public_cloud_connectors
Type	Resource
Id	azure.hybrid_connectivity.public_cloud_connectors

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
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, publicCloudConnector		Get a PublicCloudConnector
list_by_resource_group	select	subscriptionId, resourceGroupName		List PublicCloudConnector resources by resource group
list_by_subscription	select	subscriptionId		List PublicCloudConnector resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, publicCloudConnector		Create a PublicCloudConnector
update	update	subscriptionId, resourceGroupName, publicCloudConnector		Update a PublicCloudConnector
delete	delete	subscriptionId, resourceGroupName, publicCloudConnector		Delete a PublicCloudConnector
test_permissions	exec	subscriptionId, resourceGroupName, publicCloudConnector		A long-running resource action.

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
publicCloudConnector	string	Represent public cloud connectors resource.
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 a PublicCloudConnector

SELECT
location,
properties,
tags
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND publicCloudConnector = '{{ publicCloudConnector }}' -- required
;

list_by_resource_group

List PublicCloudConnector resources by resource group

SELECT
location,
properties,
tags
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List PublicCloudConnector resources by subscription ID

SELECT
location,
properties,
tags
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a PublicCloudConnector

INSERT INTO azure.hybrid_connectivity.public_cloud_connectors (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
publicCloudConnector
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ publicCloudConnector }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: public_cloud_connectors
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the public_cloud_connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the public_cloud_connectors resource.
    - name: publicCloudConnector
      value: string
      description: Required parameter for the public_cloud_connectors resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a PublicCloudConnector

UPDATE azure.hybrid_connectivity.public_cloud_connectors
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND publicCloudConnector = '{{ publicCloudConnector }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a PublicCloudConnector

DELETE FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND publicCloudConnector = '{{ publicCloudConnector }}' --required
;

Lifecycle Methods

test_permissions

A long-running resource action.

EXEC azure.hybrid_connectivity.public_cloud_connectors.test_permissions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@publicCloudConnector='{{ publicCloudConnector }}' --required
;