Share via

Documentation interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Documentation.

Methods

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Creates a new Documentation or updates an existing one.
delete(string, string, string, string, DocumentationDeleteOptionalParams)

Deletes the specified Documentation from an API.
get(string, string, string, DocumentationGetOptionalParams)

Gets the details of the Documentation specified by its identifier.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Documentation by its identifier.
listByService(string, string, DocumentationListByServiceOptionalParams)

Lists all Documentations of the API Management service instance.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Updates the details of the Documentation for an API specified by its identifier.

Method Details

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Creates a new Documentation or updates an existing one.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

documentationId

string

Documentation identifier. Must be unique in the current API Management service instance.

parameters
DocumentationContract

Create parameters.

options
DocumentationCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Deletes the specified Documentation from an API.

function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): 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.

documentationId

string

Documentation identifier. Must be unique in the current API Management service instance.

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
DocumentationDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Gets the details of the Documentation specified by its identifier.

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

documentationId

string

Documentation identifier. Must be unique in the current API Management service instance.

options
DocumentationGetOptionalParams

The options parameters.

Returns

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Documentation by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

documentationId

string

Documentation identifier. Must be unique in the current API Management service instance.

options
DocumentationGetEntityTagOptionalParams

The options parameters.

Returns

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Lists all Documentations of the API Management service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options
DocumentationListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Updates the details of the Documentation for an API specified by its identifier.

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

documentationId

string

Documentation identifier. Must be unique in the current API Management service instance.

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.

parameters
DocumentationUpdateContract

Documentation Update parameters.

options
DocumentationUpdateOptionalParams

The options parameters.

Returns

Promise<DocumentationUpdateResponse>