workspace_global_schemata

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

Overview

Name	workspace_global_schemata
Type	Resource
Id	azure.api_management.workspace_global_schemata

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Schema entity.

Name	Datatype	Description
properties	object	Properties of the Global Schema.

list_by_service

Lists a collection of Schema entities.

Name	Datatype	Description
properties	object	Properties of the Global Schema.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, schemaId, subscriptionId		Gets the details of the Schema specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$filter, $top, $skip	Lists a collection of schemas registered with workspace in a service instance.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, schemaId, subscriptionId	If-Match	Creates new or updates existing specified Schema of the workspace in an API Management service instance.
delete	delete	resourceGroupName, serviceName, workspaceId, schemaId, If-Match, subscriptionId		Deletes specific Schema.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
schemaId	string	Schema id identifier. Must be unique in the current API Management service instance.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the Schema specified by its identifier.

SELECT
properties
FROM azure.api_management.workspace_global_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND schemaId = '{{ schemaId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
properties
FROM azure.api_management.workspace_global_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_schemata (
data__properties,
resourceGroupName,
serviceName,
workspaceId,
schemaId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ schemaId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_global_schemata
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_global_schemata resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_global_schemata resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_global_schemata resource.
    - name: schemaId
      value: string
      description: Required parameter for the workspace_global_schemata resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_global_schemata resource.
    - name: properties
      value: object
      description: |
        Properties of the Global Schema.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Deletes specific Schema.

DELETE FROM azure.api_management.workspace_global_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --required
AND schemaId = '{{ schemaId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;