dynamic_schemas

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

Overview

Name	dynamic_schemas
Type	Resource
Id	azure.workload_orchestration.dynamic_schemas

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.
configurationModel	string	Type of configuration model. Known values are: "Application" and "Common". (Application, Common)
configurationType	string	Type of configuration. Known values are: "Shared" and "Hierarchy". (Shared, Hierarchy)
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_schema

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.
configurationModel	string	Type of configuration model. Known values are: "Application" and "Common". (Application, Common)
configurationType	string	Type of configuration. Known values are: "Shared" and "Hierarchy". (Shared, Hierarchy)
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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.
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, schema_name, dynamic_schema_name, subscription_id		Get a DynamicSchema Resource.
list_by_schema	select	resource_group_name, schema_name, subscription_id		List by Schema.
create_or_update	insert	resource_group_name, schema_name, dynamic_schema_name, subscription_id		Create or update a DynamicSchema Resource.
update	update	resource_group_name, schema_name, dynamic_schema_name, subscription_id		update a DynamicSchema Resource.
create_or_update	replace	resource_group_name, schema_name, dynamic_schema_name, subscription_id		Create or update a DynamicSchema Resource.
delete	delete	resource_group_name, schema_name, dynamic_schema_name, subscription_id		Delete a DynamicSchema 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
dynamic_schema_name	string	The name of the DynamicSchema. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_name	string	The name of the Schema. Required.
subscription_id	string

SELECT examples

get

Get a DynamicSchema Resource.

SELECT
id,
name,
configurationModel,
configurationType,
eTag,
provisioningState,
systemData,
type
FROM azure.workload_orchestration.dynamic_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND dynamic_schema_name = '{{ dynamic_schema_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_schema

List by Schema.

SELECT
id,
name,
configurationModel,
configurationType,
eTag,
provisioningState,
systemData,
type
FROM azure.workload_orchestration.dynamic_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a DynamicSchema Resource.

INSERT INTO azure.workload_orchestration.dynamic_schemas (
properties,
resource_group_name,
schema_name,
dynamic_schema_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ schema_name }}',
'{{ dynamic_schema_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dynamic_schemas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dynamic_schemas resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the dynamic_schemas resource.
  - name: dynamic_schema_name
    value: "{{ dynamic_schema_name }}"
    description: Required parameter for the dynamic_schemas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dynamic_schemas resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      configurationType: "{{ configurationType }}"
      configurationModel: "{{ configurationModel }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

update a DynamicSchema Resource.

UPDATE azure.workload_orchestration.dynamic_schemas
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND dynamic_schema_name = '{{ dynamic_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a DynamicSchema Resource.

REPLACE azure.workload_orchestration.dynamic_schemas
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND dynamic_schema_name = '{{ dynamic_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

DELETE examples

delete

Delete a DynamicSchema Resource.

DELETE FROM azure.workload_orchestration.dynamic_schemas
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND dynamic_schema_name = '{{ dynamic_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;