metadata_schemas

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

Overview

Name	metadata_schemas
Type	Resource
Id	azure.api_center.metadata_schemas

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, metadataSchemaName		Returns details of the metadata schema.
list	select	subscriptionId, resourceGroupName, serviceName	$filter	Returns a collection of metadata schemas.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, metadataSchemaName		Creates new or updates existing metadata schema.
delete	delete	subscriptionId, resourceGroupName, serviceName, metadataSchemaName		Deletes specified metadata 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
metadataSchemaName	string	The name of the metadata schema.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of Azure API Center service.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	OData filter parameter.

SELECT examples

get

Returns details of the metadata schema.

SELECT
properties
FROM azure.api_center.metadata_schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND metadataSchemaName = '{{ metadataSchemaName }}' -- required
;

list

Returns a collection of metadata schemas.

SELECT
properties
FROM azure.api_center.metadata_schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing metadata schema.

INSERT INTO azure.api_center.metadata_schemas (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
metadataSchemaName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ metadataSchemaName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: metadata_schemas
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the metadata_schemas resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: serviceName
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: metadataSchemaName
      value: string
      description: Required parameter for the metadata_schemas resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Deletes specified metadata schema.

DELETE FROM azure.api_center.metadata_schemas
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND metadataSchemaName = '{{ metadataSchemaName }}' --required
;