Share via

ContentItem interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a ContentItem.

Methods

createOrUpdate(string, string, string, string, ContentItemContract, ContentItemCreateOrUpdateOptionalParams)

Creates a new developer portal's content item specified by the provided content type.
delete(string, string, string, string, string, ContentItemDeleteOptionalParams)

Removes the specified developer portal's content item.
get(string, string, string, string, ContentItemGetOptionalParams)

Returns the developer portal's content item specified by its identifier.
getEntityTag(string, string, string, string, ContentItemGetEntityTagOptionalParams)

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

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

Method Details

createOrUpdate(string, string, string, string, ContentItemContract, ContentItemCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, parameters: ContentItemContract, options?: ContentItemCreateOrUpdateOptionalParams): Promise<ContentItemCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

contentTypeId

string

Content type identifier.

contentItemId

string

Content item identifier.

parameters
ContentItemContract

Create or update parameters.

options
ContentItemCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ContentItemCreateOrUpdateResponse>

delete(string, string, string, string, string, ContentItemDeleteOptionalParams)

Removes the specified developer portal's content item.

function delete(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, ifMatch: string, options?: ContentItemDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

contentTypeId

string

Content type identifier.

contentItemId

string

Content item identifier.

ifMatch

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.

options
ContentItemDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ContentItemGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, options?: ContentItemGetOptionalParams): Promise<ContentItemGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

contentTypeId

string

Content type identifier.

contentItemId

string

Content item identifier.

options
ContentItemGetOptionalParams

The options parameters.

Returns

Promise<ContentItemGetResponse>

getEntityTag(string, string, string, string, ContentItemGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, options?: ContentItemGetEntityTagOptionalParams): Promise<ContentItemGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

contentTypeId

string

Content type identifier.

contentItemId

string

Content item identifier.

options
ContentItemGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ContentItemGetEntityTagHeaders>

listByService(string, string, string, ContentItemListByServiceOptionalParams)

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

function listByService(resourceGroupName: string, serviceName: string, contentTypeId: string, options?: ContentItemListByServiceOptionalParams): PagedAsyncIterableIterator<ContentItemContract, ContentItemContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

contentTypeId

string

Content type identifier.

options
ContentItemListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContentItemContract, ContentItemContract[], PageSettings>