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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
awsCloudProfile	object	Cloud profile for AWS. Required.
connectorPrimaryIdentifier	string	Connector primary identifier.
hostType	string	Host cloud the public cloud connector. Required. "AWS" (AWS)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
awsCloudProfile	object	Cloud profile for AWS. Required.
connectorPrimaryIdentifier	string	Connector primary identifier.
hostType	string	Host cloud the public cloud connector. Required. "AWS" (AWS)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
awsCloudProfile	object	Cloud profile for AWS. Required.
connectorPrimaryIdentifier	string	Connector primary identifier.
hostType	string	Host cloud the public cloud connector. Required. "AWS" (AWS)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, public_cloud_connector, subscription_id		Get a PublicCloudConnector.
list_by_resource_group	select	resource_group_name, subscription_id		List PublicCloudConnector resources by resource group.
list_by_subscription	select	subscription_id		List PublicCloudConnector resources by subscription ID.
create_or_update	insert	resource_group_name, public_cloud_connector, subscription_id, location		Create a PublicCloudConnector.
update	update	resource_group_name, public_cloud_connector, subscription_id		Update a PublicCloudConnector.
create_or_update	replace	resource_group_name, public_cloud_connector, subscription_id, location		Create a PublicCloudConnector.
delete	delete	resource_group_name, public_cloud_connector, subscription_id		Delete a PublicCloudConnector.
test_permissions	exec	resource_group_name, public_cloud_connector, subscription_id		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
public_cloud_connector	string	Represent public cloud connectors resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a PublicCloudConnector.

SELECT
id,
name,
awsCloudProfile,
connectorPrimaryIdentifier,
hostType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND public_cloud_connector = '{{ public_cloud_connector }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List PublicCloudConnector resources by resource group.

SELECT
id,
name,
awsCloudProfile,
connectorPrimaryIdentifier,
hostType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List PublicCloudConnector resources by subscription ID.

SELECT
id,
name,
awsCloudProfile,
connectorPrimaryIdentifier,
hostType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a PublicCloudConnector.

INSERT INTO azure.hybrid_connectivity.public_cloud_connectors (
tags,
location,
properties,
resource_group_name,
public_cloud_connector,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ public_cloud_connector }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: public_cloud_connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the public_cloud_connectors resource.
  - name: public_cloud_connector
    value: "{{ public_cloud_connector }}"
    description: Required parameter for the public_cloud_connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the public_cloud_connectors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      awsCloudProfile:
        accountId: "{{ accountId }}"
        excludedAccounts:
          - "{{ excludedAccounts }}"
        isOrganizationalAccount: {{ isOrganizationalAccount }}
      hostType: "{{ hostType }}"
      provisioningState: "{{ provisioningState }}"
      connectorPrimaryIdentifier: "{{ connectorPrimaryIdentifier }}"

UPDATE examples

update

Update a PublicCloudConnector.

UPDATE azure.hybrid_connectivity.public_cloud_connectors
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND public_cloud_connector = '{{ public_cloud_connector }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a PublicCloudConnector.

REPLACE azure.hybrid_connectivity.public_cloud_connectors
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND public_cloud_connector = '{{ public_cloud_connector }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a PublicCloudConnector.

DELETE FROM azure.hybrid_connectivity.public_cloud_connectors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND public_cloud_connector = '{{ public_cloud_connector }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

test_permissions

A long-running resource action.

EXEC azure.hybrid_connectivity.public_cloud_connectors.test_permissions 
@resource_group_name='{{ resource_group_name }}' --required, 
@public_cloud_connector='{{ public_cloud_connector }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;