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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
assignedTo	array	The assignees.
schema	string	The schema defining the type. Required.
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
assignedTo	array	The assignees.
schema	string	The schema defining the type. Required.
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, metadata_schema_name, subscription_id		Returns details of the metadata schema.
list	select	resource_group_name, service_name, subscription_id	$filter	Returns a collection of metadata schemas.
create_or_update	insert	resource_group_name, service_name, metadata_schema_name, subscription_id		Creates new or updates existing metadata schema.
create_or_update	replace	resource_group_name, service_name, metadata_schema_name, subscription_id		Creates new or updates existing metadata schema.
delete	delete	resource_group_name, service_name, metadata_schema_name, subscription_id		Deletes specified metadata schema.
head	exec	resource_group_name, service_name, metadata_schema_name, subscription_id		Checks if specified metadata schema exists.

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
metadata_schema_name	string	The name of the metadata schema. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of Azure API Center service. Required.
subscription_id	string
$filter	string	OData filter parameter. Default value is None.

SELECT examples

get

Returns details of the metadata schema.

SELECT
id,
name,
assignedTo,
schema,
systemData,
type
FROM azure.api_center.metadata_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND metadata_schema_name = '{{ metadata_schema_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a collection of metadata schemas.

SELECT
id,
name,
assignedTo,
schema,
systemData,
type
FROM azure.api_center.metadata_schemas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing metadata schema.

INSERT INTO azure.api_center.metadata_schemas (
properties,
resource_group_name,
service_name,
metadata_schema_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ metadata_schema_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: metadata_schemas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the metadata_schemas resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the metadata_schemas resource.
  - name: metadata_schema_name
    value: "{{ metadata_schema_name }}"
    description: Required parameter for the metadata_schemas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the metadata_schemas resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      schema: "{{ schema }}"
      assignedTo:
        - entity: "{{ entity }}"
          required: {{ required }}
          deprecated: {{ deprecated }}

REPLACE examples

create_or_update

Creates new or updates existing metadata schema.

REPLACE azure.api_center.metadata_schemas
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND metadata_schema_name = '{{ metadata_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specified metadata schema.

DELETE FROM azure.api_center.metadata_schemas
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND metadata_schema_name = '{{ metadata_schema_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks if specified metadata schema exists.

EXEC azure.api_center.metadata_schemas.head 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@metadata_schema_name='{{ metadata_schema_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;