cloud_links

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

Overview

Name	cloud_links
Type	Resource
Id	azure_isv.avs.cloud_links

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.
linkedCloud	string	Identifier of the other private cloud participating in the link.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The state of the cloud link. Known values are: "Active", "Building", "Deleting", "Failed", and "Disconnected". (Active, Building, Deleting, Failed, Disconnected)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
linkedCloud	string	Identifier of the other private cloud participating in the link.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The state of the cloud link. Known values are: "Active", "Building", "Deleting", "Failed", and "Disconnected". (Active, Building, Deleting, Failed, Disconnected)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, private_cloud_name, cloud_link_name, subscription_id		Get a CloudLink.
list	select	resource_group_name, private_cloud_name, subscription_id		List CloudLink resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, cloud_link_name, subscription_id		Create a CloudLink.
create_or_update	replace	resource_group_name, private_cloud_name, cloud_link_name, subscription_id		Create a CloudLink.
delete	delete	resource_group_name, private_cloud_name, cloud_link_name, subscription_id		Delete a CloudLink.

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
cloud_link_name	string	Name of the cloud link. Required.
private_cloud_name	string	Name of the private cloud. 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 CloudLink.

SELECT
id,
name,
linkedCloud,
provisioningState,
status,
systemData,
type
FROM azure_isv.avs.cloud_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cloud_link_name = '{{ cloud_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List CloudLink resources by PrivateCloud.

SELECT
id,
name,
linkedCloud,
provisioningState,
status,
systemData,
type
FROM azure_isv.avs.cloud_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a CloudLink.

INSERT INTO azure_isv.avs.cloud_links (
properties,
resource_group_name,
private_cloud_name,
cloud_link_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ cloud_link_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cloud_links
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cloud_links resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the cloud_links resource.
  - name: cloud_link_name
    value: "{{ cloud_link_name }}"
    description: Required parameter for the cloud_links resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cloud_links resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      linkedCloud: "{{ linkedCloud }}"

REPLACE examples

create_or_update

Create a CloudLink.

REPLACE azure_isv.avs.cloud_links
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND cloud_link_name = '{{ cloud_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a CloudLink.

DELETE FROM azure_isv.avs.cloud_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND cloud_link_name = '{{ cloud_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;