schema_references

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

Overview

Name	schema_references
Type	Resource
Id	azure.workload_orchestration.schema_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.
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)
schemaId	string	Schema Id of schema reference. 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_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.
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)
schemaId	string	Schema Id of schema reference. 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_uri, schema_reference_name		Get a Schema Reference Resource.
list_by_resource_group	select	resource_uri		List by specified resource group.

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
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
schema_reference_name	string	The name of the SchemaReference. Required.

SELECT examples

get

Get a Schema Reference Resource.

SELECT
id,
name,
eTag,
provisioningState,
schemaId,
systemData,
type
FROM azure.workload_orchestration.schema_references
WHERE resource_uri = '{{ resource_uri }}' -- required
AND schema_reference_name = '{{ schema_reference_name }}' -- required
;

list_by_resource_group

List by specified resource group.

SELECT
id,
name,
eTag,
provisioningState,
schemaId,
systemData,
type
FROM azure.workload_orchestration.schema_references
WHERE resource_uri = '{{ resource_uri }}' -- required
;