workspace_global_schema

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

Overview

Name	workspace_global_schema
Type	Resource
Id	azure.api_management.workspace_global_schema

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.
description	string	Free-form schema entity description.
document	object	Global Schema document object for json-based schema formats(e.g. json schema).
provisioningState	string	The provisioning state.
schemaType	string	Schema Type. Immutable. Required. Known values are: "xml" and "json". (xml, json)
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".
value	object	Json-encoded string for non json-based schema.

list_by_service

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.
description	string	Free-form schema entity description.
document	object	Global Schema document object for json-based schema formats(e.g. json schema).
provisioningState	string	The provisioning state.
schemaType	string	Schema Type. Immutable. Required. Known values are: "xml" and "json". (xml, json)
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".
value	object	Json-encoded string for non json-based schema.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_id, schema_id, subscription_id		Gets the details of the Schema specified by its identifier.
list_by_service	select	resource_group_name, service_name, workspace_id, subscription_id	$filter, $top, $skip	Lists a collection of schemas registered with workspace in a service instance.
create_or_update	insert	resource_group_name, service_name, workspace_id, schema_id, subscription_id		Creates new or updates existing specified Schema of the workspace in an API Management service instance.
create_or_update	replace	resource_group_name, service_name, workspace_id, schema_id, subscription_id		Creates new or updates existing specified Schema of the workspace in an API Management service instance.
delete	delete	resource_group_name, service_name, workspace_id, schema_id, subscription_id		Deletes specific Schema.
get_entity_tag	exec	resource_group_name, service_name, workspace_id, schema_id, subscription_id		Gets the entity state (Etag) version of the Schema specified by its identifier.

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_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_id	string	Schema id identifier. Must be unique in the current API Management service instance. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the Schema specified by its identifier.

SELECT
id,
name,
description,
document,
provisioningState,
schemaType,
systemData,
type,
value
FROM azure.api_management.workspace_global_schema
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND schema_id = '{{ schema_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of schemas registered with workspace in a service instance.

SELECT
id,
name,
description,
document,
provisioningState,
schemaType,
systemData,
type,
value
FROM azure.api_management.workspace_global_schema
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates new or updates existing specified Schema of the workspace in an API Management service instance.

INSERT INTO azure.api_management.workspace_global_schema (
properties,
resource_group_name,
service_name,
workspace_id,
schema_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ schema_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_global_schema
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_global_schema resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace_global_schema resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_global_schema resource.
  - name: schema_id
    value: "{{ schema_id }}"
    description: Required parameter for the workspace_global_schema resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_global_schema resource.
  - name: properties
    description: |
      Properties of the Global Schema.
    value:
      schemaType: "{{ schemaType }}"
      description: "{{ description }}"
      value: "{{ value }}"
      document: "{{ document }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates new or updates existing specified Schema of the workspace in an API Management service instance.

REPLACE azure.api_management.workspace_global_schema
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND schema_id = '{{ schema_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific Schema.

DELETE FROM azure.api_management.workspace_global_schema
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND schema_id = '{{ schema_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the Schema specified by its identifier.

EXEC azure.api_management.workspace_global_schema.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@schema_id='{{ schema_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;