global_schemata

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

Overview

Name	global_schemata
Type	Resource
Id	azure.api_management.global_schemata

Fields

vw_global_schemata

Name	Datatype	Description
description	text	field from the properties object
document	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
schemaId	text	field from the properties object
schema_type	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
value	text	field from the properties object

global_schemata

Name	Datatype	Description
properties	object	Schema create or update contract Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, schemaId, serviceName, subscriptionId	Gets the details of the Schema specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of schemas registered with service instance.
create_or_update	INSERT	resourceGroupName, schemaId, serviceName, subscriptionId	Creates new or updates existing specified Schema of the API Management service instance.
delete	DELETE	If-Match, resourceGroupName, schemaId, serviceName, subscriptionId	Deletes specific Schema.

SELECT examples

Lists a collection of schemas registered with service instance.

vw_global_schemata

SELECT
description,
document,
provisioning_state,
resourceGroupName,
schemaId,
schema_type,
serviceName,
subscriptionId,
value
FROM azure.api_management.vw_global_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

global_schemata

SELECT
properties
FROM azure.api_management.global_schemata
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new global_schemata resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.global_schemata (
resourceGroupName,
schemaId,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ schemaId }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: schemaType
          value: string
        - name: description
          value: string
        - name: value
          value: string
        - name: document
          value: []
        - name: provisioningState
          value: string

DELETE example

Deletes the specified global_schemata resource.

/*+ delete */
DELETE FROM azure.api_management.global_schemata
WHERE If-Match = '{{ If-Match }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND schemaId = '{{ schemaId }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';