content_items

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

Overview

Name	content_items
Type	Resource
Id	azure.api_management.content_items

Fields

The following fields are returned by SELECT queries:

get

Returns the content item.

Name	Datatype	Description
properties	object	Properties of the content item.

list_by_service

Returns a collection of Content Type entities.

Name	Datatype	Description
properties	object	Properties of the content item.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, contentTypeId, contentItemId, subscriptionId		Returns the developer portal's content item specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, contentTypeId, subscriptionId		Lists developer portal's content items specified by the provided content type.
create_or_update	insert	resourceGroupName, serviceName, contentTypeId, contentItemId, subscriptionId	If-Match	Creates a new developer portal's content item specified by the provided content type.
delete	delete	resourceGroupName, serviceName, contentTypeId, contentItemId, If-Match, subscriptionId		Removes the specified developer portal's content item.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
contentItemId	string	Content item identifier.
contentTypeId	string	Content type identifier.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

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

SELECT
properties
FROM azure.api_management.content_items
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND contentTypeId = '{{ contentTypeId }}' -- required
AND contentItemId = '{{ contentItemId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
properties
FROM azure.api_management.content_items
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND contentTypeId = '{{ contentTypeId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_items (
data__properties,
resourceGroupName,
serviceName,
contentTypeId,
contentItemId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ contentTypeId }}',
'{{ contentItemId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: content_items
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the content_items resource.
    - name: serviceName
      value: string
      description: Required parameter for the content_items resource.
    - name: contentTypeId
      value: string
      description: Required parameter for the content_items resource.
    - name: contentItemId
      value: string
      description: Required parameter for the content_items resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the content_items resource.
    - name: properties
      value: object
      description: |
        Properties of the content item.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Removes the specified developer portal's content item.

DELETE FROM azure.api_management.content_items
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND contentTypeId = '{{ contentTypeId }}' --required
AND contentItemId = '{{ contentItemId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;