ContentItem | @azure/arm-apimanagement

Interface representing a ContentItem.

Hierarchy

ContentItem

Implemented by

ContentItemImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/contentItem.ts:77
Creates a new developer portal's content item specified by the provided content type.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- contentTypeId: string
  
  Content type identifier.
- contentItemId: string
  
  Content item identifier.
- Optional options: ContentItemCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ContentItemCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/contentItem.ts:94
Removes the specified developer portal's content item.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ContentItemDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/contentItem.ts:62
Returns the developer portal's content item specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- contentTypeId: string
  
  Content type identifier.
- contentItemId: string
  
  Content item identifier.
- Optional options: ContentItemGetOptionalParams
  
  The options parameters.
Returns Promise<ContentItemGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/contentItem.ts:47
Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- contentTypeId: string
  
  Content type identifier.
- contentItemId: string
  
  Content item identifier.
- Optional options: ContentItemGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ContentItemGetEntityTagResponse>

listByService

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

- Defined in operationsInterfaces/contentItem.ts:32
Lists developer portal's content items specified by the provided content type.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- contentTypeId: string
  
  Content type identifier.
- Optional options: ContentItemListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContentItemContract>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

contentItemId: string

Optional options: ContentItemCreateOrUpdateOptionalParams

Returns Promise<ContentItemCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

contentItemId: string

ifMatch: string

Optional options: ContentItemDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

contentItemId: string

Optional options: ContentItemGetOptionalParams

Returns Promise<ContentItemGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

contentItemId: string

Optional options: ContentItemGetEntityTagOptionalParams

Returns Promise<ContentItemGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

Optional options: ContentItemListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ContentItemContract>