content_item

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

Overview

Name	content_item
Type	Resource
Id	azure.api_management.content_item

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.
properties	object	Properties of the content item.
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_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.
properties	object	Properties of the content item.
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, content_type_id, content_item_id, subscription_id		Returns the developer portal's content item specified by its identifier.
list_by_service	select	resource_group_name, service_name, content_type_id, subscription_id		Lists developer portal's content items specified by the provided content type.
create_or_update	insert	resource_group_name, service_name, content_type_id, content_item_id, subscription_id		Creates a new developer portal's content item specified by the provided content type.
create_or_update	replace	resource_group_name, service_name, content_type_id, content_item_id, subscription_id		Creates a new developer portal's content item specified by the provided content type.
delete	delete	resource_group_name, service_name, content_type_id, content_item_id, subscription_id		Removes the specified developer portal's content item.
get_entity_tag	exec	resource_group_name, service_name, content_type_id, content_item_id, subscription_id		Returns the entity state (ETag) version of the developer portal's content item 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
content_item_id	string	Content item identifier. Required.
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

Returns the developer portal's content item specified by its identifier.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.api_management.content_item
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND content_type_id = '{{ content_type_id }}' -- required
AND content_item_id = '{{ content_item_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists developer portal's content items specified by the provided content type.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.api_management.content_item
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
;

INSERT examples

create_or_update

Creates a new developer portal's content item specified by the provided content type.

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

Manifest

# Description fields are for documentation purposes
- name: content_item
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the content_item resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the content_item resource.
  - name: content_type_id
    value: "{{ content_type_id }}"
    description: Required parameter for the content_item resource.
  - name: content_item_id
    value: "{{ content_item_id }}"
    description: Required parameter for the content_item resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the content_item resource.
  - name: properties
    value: "{{ properties }}"
    description: |
      Properties of the content item.

REPLACE examples

create_or_update

Creates a new developer portal's content item specified by the provided content type.

REPLACE azure.api_management.content_item
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 content_item_id = '{{ content_item_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Removes the specified developer portal's content item.

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

Lifecycle Methods

get_entity_tag

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

EXEC azure.api_management.content_item.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@content_type_id='{{ content_type_id }}' --required, 
@content_item_id='{{ content_item_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;