ApiTagDescription | @azure/arm-apimanagement

Interface representing a ApiTagDescription.

Hierarchy

ApiTagDescription

Implemented by

ApiTagDescriptionImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/apiTagDescription.ts:86
Create/Update tag description in scope of the Api.

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

delete

delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/apiTagDescription.ts:106
Delete tag description for the Api.

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

get

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

- Defined in operationsInterfaces/apiTagDescription.ts:68
Get Tag description in scope of API

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

getEntityTag

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

- Defined in operationsInterfaces/apiTagDescription.ts:51
Gets the entity state version of the tag specified by its identifier.

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

listByService

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

- Defined in operationsInterfaces/apiTagDescription.ts:35
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

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiTagDescriptionListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagDescriptionContract>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagDescriptionId: string

parameters: TagDescriptionCreateParameters

Optional options: ApiTagDescriptionCreateOrUpdateOptionalParams

Returns Promise<ApiTagDescriptionCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagDescriptionId: string

ifMatch: string

Optional options: ApiTagDescriptionDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagDescriptionId: string

Optional options: ApiTagDescriptionGetOptionalParams

Returns Promise<ApiTagDescriptionGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagDescriptionId: string

Optional options: ApiTagDescriptionGetEntityTagOptionalParams

Returns Promise<ApiTagDescriptionGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiTagDescriptionListByServiceOptionalParams

Returns PagedAsyncIterableIterator<TagDescriptionContract>