linked_subscriptions

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

Overview

Name	linked_subscriptions
Type	Resource
Id	azure_stack.azure_stack.linked_subscriptions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
deviceConnectionStatus	string	The status of the remote management connection of the Azure Stack device.
deviceId	string	The identifier of the Azure Stack device for remote management.
deviceLinkState	string	The connection state of the Azure Stack device.
deviceObjectId	string	The object identifier associated with the Azure Stack device connecting to Azure.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
lastConnectedTime	string	The last remote management connection time for the Azure Stack device connected to the linked subscription resource.
linkedSubscriptionId	string	The identifier associated with the device subscription.
location	string	Location of the resource. Required. "global"
registrationResourceId	string	The identifier associated with the device registration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
type	string	Type of Resource.

list_by_resource_group

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
deviceConnectionStatus	string	The status of the remote management connection of the Azure Stack device.
deviceId	string	The identifier of the Azure Stack device for remote management.
deviceLinkState	string	The connection state of the Azure Stack device.
deviceObjectId	string	The object identifier associated with the Azure Stack device connecting to Azure.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
lastConnectedTime	string	The last remote management connection time for the Azure Stack device connected to the linked subscription resource.
linkedSubscriptionId	string	The identifier associated with the device subscription.
location	string	Location of the resource. Required. "global"
registrationResourceId	string	The identifier associated with the device registration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
type	string	Type of Resource.

list_by_subscription

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
deviceConnectionStatus	string	The status of the remote management connection of the Azure Stack device.
deviceId	string	The identifier of the Azure Stack device for remote management.
deviceLinkState	string	The connection state of the Azure Stack device.
deviceObjectId	string	The object identifier associated with the Azure Stack device connecting to Azure.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
lastConnectedTime	string	The last remote management connection time for the Azure Stack device connected to the linked subscription resource.
linkedSubscriptionId	string	The identifier associated with the device subscription.
location	string	Location of the resource. Required. "global"
registrationResourceId	string	The identifier associated with the device registration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group, linked_subscription_name, subscription_id		Returns the properties of a Linked Subscription resource.
list_by_resource_group	select	resource_group, subscription_id		Returns a list of all linked subscriptions under current resource group.
list_by_subscription	select	subscription_id		Returns a list of all linked subscriptions under current subscription.
create_or_update	insert	resource_group, linked_subscription_name, subscription_id, location, properties		Create or update a linked subscription resource.
update	update	resource_group, linked_subscription_name, subscription_id, location, properties		Patch a Linked Subscription resource.
create_or_update	replace	resource_group, linked_subscription_name, subscription_id, location, properties		Create or update a linked subscription resource.
delete	delete	resource_group, linked_subscription_name, subscription_id		Delete the requested Linked Subscription 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
linked_subscription_name	string	Name of the Linked Subscription resource. Required.
resource_group	string	Name of the resource group. Required.
subscription_id	string

SELECT examples

get

Returns the properties of a Linked Subscription resource.

SELECT
id,
name,
deviceConnectionStatus,
deviceId,
deviceLinkState,
deviceObjectId,
etag,
kind,
lastConnectedTime,
linkedSubscriptionId,
location,
registrationResourceId,
systemData,
tags,
type
FROM azure_stack.azure_stack.linked_subscriptions
WHERE resource_group = '{{ resource_group }}' -- required
AND linked_subscription_name = '{{ linked_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns a list of all linked subscriptions under current resource group.

SELECT
id,
name,
deviceConnectionStatus,
deviceId,
deviceLinkState,
deviceObjectId,
etag,
kind,
lastConnectedTime,
linkedSubscriptionId,
location,
registrationResourceId,
systemData,
tags,
type
FROM azure_stack.azure_stack.linked_subscriptions
WHERE resource_group = '{{ resource_group }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns a list of all linked subscriptions under current subscription.

SELECT
id,
name,
deviceConnectionStatus,
deviceId,
deviceLinkState,
deviceObjectId,
etag,
kind,
lastConnectedTime,
linkedSubscriptionId,
location,
registrationResourceId,
systemData,
tags,
type
FROM azure_stack.azure_stack.linked_subscriptions
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a linked subscription resource.

INSERT INTO azure_stack.azure_stack.linked_subscriptions (
location,
properties,
resource_group,
linked_subscription_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group }}',
'{{ linked_subscription_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: linked_subscriptions
props:
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the linked_subscriptions resource.
  - name: linked_subscription_name
    value: "{{ linked_subscription_name }}"
    description: Required parameter for the linked_subscriptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the linked_subscriptions resource.
  - name: location
    value: "{{ location }}"
    description: |
      Location of the resource. Required. "global"
  - name: properties
    value:
      linkedSubscriptionId: "{{ linkedSubscriptionId }}"
      registrationResourceId: "{{ registrationResourceId }}"

UPDATE examples

update

Patch a Linked Subscription resource.

UPDATE azure_stack.azure_stack.linked_subscriptions
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND linked_subscription_name = '{{ linked_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a linked subscription resource.

REPLACE azure_stack.azure_stack.linked_subscriptions
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND linked_subscription_name = '{{ linked_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the requested Linked Subscription resource.

DELETE FROM azure_stack.azure_stack.linked_subscriptions
WHERE resource_group = '{{ resource_group }}' --required
AND linked_subscription_name = '{{ linked_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;