global_reach_connections

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

Overview

Name	global_reach_connections
Type	Resource
Id	azure_isv.avs.global_reach_connections

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.
addressPrefix	string	The network used for global reach carved out from the original network block provided for the private cloud.
authorizationKey	string	Authorization key from the peer express route used for the global reach connection.
circuitConnectionStatus	string	The connection status of the global reach connection. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
expressRouteId	string	The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection.
peerExpressRouteCircuit	string	Identifier of the ExpressRoute Circuit to peer with in the global reach connection.
provisioningState	string	The state of the ExpressRoute Circuit Authorization provisioning. Known values are: "Succeeded", "Failed", "Canceled", and "Updating". (Succeeded, Failed, Canceled, Updating)
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.
addressPrefix	string	The network used for global reach carved out from the original network block provided for the private cloud.
authorizationKey	string	Authorization key from the peer express route used for the global reach connection.
circuitConnectionStatus	string	The connection status of the global reach connection. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
expressRouteId	string	The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection.
peerExpressRouteCircuit	string	Identifier of the ExpressRoute Circuit to peer with in the global reach connection.
provisioningState	string	The state of the ExpressRoute Circuit Authorization provisioning. Known values are: "Succeeded", "Failed", "Canceled", and "Updating". (Succeeded, Failed, Canceled, Updating)
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, global_reach_connection_name, subscription_id		Get a GlobalReachConnection.
list	select	resource_group_name, private_cloud_name, subscription_id		List GlobalReachConnection resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, global_reach_connection_name, subscription_id		Create a GlobalReachConnection.
create_or_update	replace	resource_group_name, private_cloud_name, global_reach_connection_name, subscription_id		Create a GlobalReachConnection.
delete	delete	resource_group_name, private_cloud_name, global_reach_connection_name, subscription_id		Delete a GlobalReachConnection.

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
global_reach_connection_name	string	Name of the global reach connection. 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 GlobalReachConnection.

SELECT
id,
name,
addressPrefix,
authorizationKey,
circuitConnectionStatus,
expressRouteId,
peerExpressRouteCircuit,
provisioningState,
systemData,
type
FROM azure_isv.avs.global_reach_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND global_reach_connection_name = '{{ global_reach_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List GlobalReachConnection resources by PrivateCloud.

SELECT
id,
name,
addressPrefix,
authorizationKey,
circuitConnectionStatus,
expressRouteId,
peerExpressRouteCircuit,
provisioningState,
systemData,
type
FROM azure_isv.avs.global_reach_connections
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 GlobalReachConnection.

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

Manifest

# Description fields are for documentation purposes
- name: global_reach_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the global_reach_connections resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the global_reach_connections resource.
  - name: global_reach_connection_name
    value: "{{ global_reach_connection_name }}"
    description: Required parameter for the global_reach_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the global_reach_connections resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      addressPrefix: "{{ addressPrefix }}"
      authorizationKey: "{{ authorizationKey }}"
      circuitConnectionStatus: "{{ circuitConnectionStatus }}"
      peerExpressRouteCircuit: "{{ peerExpressRouteCircuit }}"
      expressRouteId: "{{ expressRouteId }}"

REPLACE examples

create_or_update

Create a GlobalReachConnection.

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

DELETE examples

delete

Delete a GlobalReachConnection.

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