workspace_api_schemata

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

Overview

Name	workspace_api_schemata
Type	Resource
Id	azure.api_management.workspace_api_schemata

Fields

The following fields are returned by SELECT queries:

get

Api Schema information.

Name	Datatype	Description
properties	object	Properties of the API Schema.

list_by_api

Apis Schema Collection.

Name	Datatype	Description
properties	object	Properties of the API Schema.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, apiId, schemaId, subscriptionId		Get the schema configuration at the API level.
list_by_api	select	resourceGroupName, serviceName, workspaceId, apiId, subscriptionId	$filter, $top, $skip	Get the schema configuration at the API level.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, apiId, schemaId, subscriptionId	If-Match	Creates or updates schema configuration for the API.
delete	delete	resourceGroupName, serviceName, workspaceId, apiId, schemaId, If-Match, subscriptionId	force	Deletes the schema configuration at the Api.

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.
apiId	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
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>| contentType | 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.
force	boolean	If true removes all references to the schema before deleting it.

SELECT examples

get

Get the schema configuration at the API level.

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

list_by_api

Get the schema configuration at the API level.

SELECT
properties
FROM azure.api_management.workspace_api_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or updates schema configuration for the API.

INSERT INTO azure.api_management.workspace_api_schemata (
data__properties,
resourceGroupName,
serviceName,
workspaceId,
apiId,
schemaId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ apiId }}',
'{{ schemaId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_api_schemata
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: apiId
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: schemaId
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_api_schemata resource.
    - name: properties
      value: object
      description: |
        Properties of the API 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 the schema configuration at the Api.

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