site_references

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

Overview

Name	site_references
Type	Resource
Id	azure.workload_orchestration.site_references

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.
provisioningState	string	Provisioning State. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
siteId	string	Azure Resource ID for Site. Required.
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_by_context

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.
provisioningState	string	Provisioning State. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
siteId	string	Azure Resource ID for Site. Required.
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, context_name, site_reference_name, subscription_id		Get Site Reference Resource.
list_by_context	select	resource_group_name, context_name, subscription_id		List Site Reference Resources.
create_or_update	insert	resource_group_name, context_name, site_reference_name, subscription_id		Get Site Reference Resource.
update	update	resource_group_name, context_name, site_reference_name, subscription_id		Get Site Reference Resource.
create_or_update	replace	resource_group_name, context_name, site_reference_name, subscription_id		Get Site Reference Resource.
delete	delete	resource_group_name, context_name, site_reference_name, subscription_id		Get Site Reference 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
context_name	string	The name of the Context. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
site_reference_name	string	The name of the SiteReference. Required.
subscription_id	string

SELECT examples

get

Get Site Reference Resource.

SELECT
id,
name,
provisioningState,
siteId,
systemData,
type
FROM azure.workload_orchestration.site_references
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND site_reference_name = '{{ site_reference_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_context

List Site Reference Resources.

SELECT
id,
name,
provisioningState,
siteId,
systemData,
type
FROM azure.workload_orchestration.site_references
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Get Site Reference Resource.

INSERT INTO azure.workload_orchestration.site_references (
properties,
resource_group_name,
context_name,
site_reference_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ context_name }}',
'{{ site_reference_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: site_references
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the site_references resource.
  - name: context_name
    value: "{{ context_name }}"
    description: Required parameter for the site_references resource.
  - name: site_reference_name
    value: "{{ site_reference_name }}"
    description: Required parameter for the site_references resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the site_references resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      siteId: "{{ siteId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Get Site Reference Resource.

UPDATE azure.workload_orchestration.site_references
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND site_reference_name = '{{ site_reference_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Get Site Reference Resource.

REPLACE azure.workload_orchestration.site_references
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND site_reference_name = '{{ site_reference_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Get Site Reference Resource.

DELETE FROM azure.workload_orchestration.site_references
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND context_name = '{{ context_name }}' --required
AND site_reference_name = '{{ site_reference_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;