contexts

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

Overview

Name	contexts
Type	Resource
Id	azure.workload_orchestration.contexts

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.
capabilities	array	List of Capabilities. Required.
hierarchies	array	List of Hierarchies. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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.
capabilities	array	List of Capabilities. Required.
hierarchies	array	List of Hierarchies. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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.
capabilities	array	List of Capabilities. Required.
hierarchies	array	List of Hierarchies. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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, context_name, subscription_id		Get Context Resource.
list_by_resource_group	select	resource_group_name, subscription_id		List by specified resource group.
list_by_subscription	select	subscription_id		List by subscription.
create_or_update	insert	resource_group_name, context_name, subscription_id, location		Create or update Context Resource.
update	update	resource_group_name, context_name, subscription_id, location		update an Context Resource.
create_or_update	replace	resource_group_name, context_name, subscription_id, location		Create or update Context Resource.
delete	delete	resource_group_name, context_name, subscription_id		Delete Context 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.
subscription_id	string

SELECT examples

get

Get Context Resource.

SELECT
id,
name,
capabilities,
hierarchies,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.contexts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND context_name = '{{ context_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List by specified resource group.

SELECT
id,
name,
capabilities,
hierarchies,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.contexts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List by subscription.

SELECT
id,
name,
capabilities,
hierarchies,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.contexts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update Context Resource.

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

Manifest

# Description fields are for documentation purposes
- name: contexts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the contexts resource.
  - name: context_name
    value: "{{ context_name }}"
    description: Required parameter for the contexts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the contexts 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:
      capabilities:
        - name: "{{ name }}"
          description: "{{ description }}"
          state: "{{ state }}"
      hierarchies:
        - name: "{{ name }}"
          description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

update an Context Resource.

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

REPLACE examples

create_or_update

Create or update Context Resource.

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

DELETE examples

delete

Delete Context Resource.

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