content_type

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

Overview

Name	content_type
Type	Resource
Id	azure.api_management.content_type

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.
description	string	Content type description.
schema	object	Content type schema.
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".
version	string	Content type version.

list_by_service

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.
description	string	Content type description.
schema	object	Content type schema.
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".
version	string	Content type version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, content_type_id, subscription_id		Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.
list_by_service	select	resource_group_name, service_name, subscription_id		Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
create_or_update	insert	resource_group_name, service_name, content_type_id, subscription_id		Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.
create_or_update	replace	resource_group_name, service_name, content_type_id, subscription_id		Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.
delete	delete	resource_group_name, service_name, content_type_id, subscription_id		Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed.

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
content_type_id	string	Content type identifier. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string

SELECT examples

get

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

SELECT
id,
name,
description,
schema,
systemData,
type,
version
FROM azure.api_management.content_type
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND content_type_id = '{{ content_type_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

SELECT
id,
name,
description,
schema,
systemData,
type,
version
FROM azure.api_management.content_type
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.

INSERT INTO azure.api_management.content_type (
properties,
resource_group_name,
service_name,
content_type_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ content_type_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: content_type
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the content_type resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the content_type resource.
  - name: content_type_id
    value: "{{ content_type_id }}"
    description: Required parameter for the content_type resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the content_type resource.
  - name: properties
    description: |
      Properties of the content type.
    value:
      id: "{{ id }}"
      name: "{{ name }}"
      description: "{{ description }}"
      schema: "{{ schema }}"
      version: "{{ version }}"

REPLACE examples

create_or_update

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.

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

DELETE examples

delete

Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed.

DELETE FROM azure.api_management.content_type
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND content_type_id = '{{ content_type_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;