api_schema

Creates, updates, deletes, gets or lists an api_schema resource.

Overview

Name	api_schema
Type	Resource
Id	azure.api_management.api_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.
contentType	string	Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema - gRPC Schema use text/protobuf. Required.
document	object	Create or update Properties of the API Schema Document. Required.
provisioningState	string	The provisioning state.
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_api

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.
contentType	string	Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema - gRPC Schema use text/protobuf. Required.
document	object	Create or update Properties of the API Schema Document. Required.
provisioningState	string	The provisioning state.
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, service_name, api_id, schema_id, subscription_id		Get the schema configuration at the API level.
list_by_api	select	resource_group_name, service_name, api_id, subscription_id	$filter, $top, $skip	Get the schema configuration at the API level.
create_or_update	insert	resource_group_name, service_name, api_id, schema_id, subscription_id		Creates or updates schema configuration for the API.
create_or_update	replace	resource_group_name, service_name, api_id, schema_id, subscription_id		Creates or updates schema configuration for the API.
delete	delete	resource_group_name, service_name, api_id, schema_id, subscription_id	force	Deletes the schema configuration at the Api.
get_entity_tag	exec	resource_group_name, service_name, api_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
api_id	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. Required.
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
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| contentType | 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.
force	boolean	If true removes all references to the schema before deleting it. Default value is None.

SELECT examples

get

Get the schema configuration at the API level.

SELECT
id,
name,
contentType,
document,
provisioningState,
systemData,
type
FROM azure.api_management.api_schema
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND schema_id = '{{ schema_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_api

Get the schema configuration at the API level.

SELECT
id,
name,
contentType,
document,
provisioningState,
systemData,
type
FROM azure.api_management.api_schema
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.api_schema (
properties,
resource_group_name,
service_name,
api_id,
schema_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ schema_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_schema
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_schema resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_schema resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_schema resource.
  - name: schema_id
    value: "{{ schema_id }}"
    description: Required parameter for the api_schema resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_schema resource.
  - name: properties
    description: |
      Properties of the API Schema.
    value:
      contentType: "{{ contentType }}"
      document:
        value: "{{ value }}"
        definitions: "{{ definitions }}"
        components: "{{ components }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates schema configuration for the API.

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

DELETE examples

delete

Deletes the schema configuration at the Api.

DELETE FROM azure.api_management.api_schema
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND schema_id = '{{ schema_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

get_entity_tag

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

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