ContentTypeImpl | @azure/arm-apimanagement

Class containing ContentType operations.

Hierarchy

ContentTypeImpl

Implements

ContentType

Index

Constructors

constructor

Methods

Constructors

constructor

new ContentTypeImpl(client: ApiManagementClientContext): ContentTypeImpl

- Defined in operations/contentType.ts:31
Initialize a new instance of the class ContentType class.

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

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, contentTypeId: string, options?: ContentTypeCreateOrUpdateOptionalParams): Promise<ContentTypeCreateOrUpdateResponse>

Implementation of ContentType.createOrUpdate
- Defined in operations/contentType.ts:160
Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.

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: ContentTypeCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ContentTypeCreateOrUpdateResponse>

delete

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

Implementation of ContentType.delete
- Defined in operations/contentType.ts:183
Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- contentTypeId: string
  
  Content type 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: ContentTypeDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, contentTypeId: string, options?: ContentTypeGetOptionalParams): Promise<ContentTypeGetResponse>

Implementation of ContentType.get
- Defined in operations/contentType.ts:139
Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

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: ContentTypeGetOptionalParams
  
  The options parameters.
Returns Promise<ContentTypeGetResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: ContentTypeListByServiceOptionalParams): PagedAsyncIterableIterator<ContentTypeContract>

Implementation of ContentType.listByService
- Defined in operations/contentType.ts:48
Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ContentTypeListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContentTypeContract>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ContentTypeImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

Optional options: ContentTypeCreateOrUpdateOptionalParams

Returns Promise<ContentTypeCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

ifMatch: string

Optional options: ContentTypeDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

contentTypeId: string

Optional options: ContentTypeGetOptionalParams

Returns Promise<ContentTypeGetResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: ContentTypeListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ContentTypeContract>