ApiTagDescription interface

Package:

@azure/arm-apimanagement

Interface representing a ApiTagDescription.

Methods

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)	Create/Update tag description in scope of the Api.
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)	Delete tag description for the Api.
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)	Get Tag description in scope of API
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)	Gets the entity state version of the tag specified by its identifier.
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)	Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

Method Details

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)

Create/Update tag description in scope of the Api.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagDescriptionId

string

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

parameters

TagDescriptionCreateParameters

Create parameters.

options

ApiTagDescriptionCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiTagDescriptionCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)

Delete tag description for the Api.

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

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagDescriptionId

string

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

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

ApiTagDescriptionDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ApiTagDescriptionGetOptionalParams)

Get Tag description in scope of API

function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagDescriptionId

string

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

options

ApiTagDescriptionGetOptionalParams

The options parameters.

Returns

Promise<ApiTagDescriptionGetResponse>

getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)

Gets the entity state version of the tag specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagDescriptionId

string

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

options

ApiTagDescriptionGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ApiTagDescriptionGetEntityTagHeaders>

listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options

ApiTagDescriptionListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>