ContentItemImpl | @azure/arm-apimanagement

Class containing ContentItem operations.

Hierarchy

ContentItemImpl

Implements

ContentItem

Index

Constructors

constructor

Methods

Constructors

constructor

new ContentItemImpl(client: ApiManagementClientContext): ContentItemImpl

- Defined in operations/contentItem.ts:33
Initialize a new instance of the class ContentItem class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ContentItemImpl

Methods

createOrUpdate

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

Implementation of ContentItem.createOrUpdate
- Defined in operations/contentItem.ts:193
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>

Implementation of ContentItem.delete
- Defined in operations/contentItem.ts:216
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>

Implementation of ContentItem.get
- Defined in operations/contentItem.ts:172
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>

Implementation of ContentItem.getEntityTag
- Defined in operations/contentItem.ts:151
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>

Implementation of ContentItem.listByService
- Defined in operations/contentItem.ts:50
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ContentItemImpl

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>