TagApiLink interface

Package:

@azure/arm-apimanagement

Interface representing a TagApiLink.

Methods

createOrUpdate(string, string, string, string, TagApiLinkContract, TagApiLinkCreateOrUpdateOptionalParams)	Adds an API to the specified tag via link.
delete(string, string, string, string, TagApiLinkDeleteOptionalParams)	Deletes the specified API from the specified tag.
get(string, string, string, string, TagApiLinkGetOptionalParams)	Gets the API link for the tag.
listByProduct(string, string, string, TagApiLinkListByProductOptionalParams)	Lists a collection of the API links associated with a tag.

Method Details

createOrUpdate(string, string, string, string, TagApiLinkContract, TagApiLinkCreateOrUpdateOptionalParams)

Adds an API to the specified tag via link.

function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, apiLinkId: string, parameters: TagApiLinkContract, options?: TagApiLinkCreateOrUpdateOptionalParams): Promise<TagApiLinkContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

tagId

string

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

apiLinkId

string

Tag-API link identifier. Must be unique in the current API Management service instance.

parameters

TagApiLinkContract

Create or update parameters.

options

TagApiLinkCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TagApiLinkContract>

delete(string, string, string, string, TagApiLinkDeleteOptionalParams)

Deletes the specified API from the specified tag.

function delete(resourceGroupName: string, serviceName: string, tagId: string, apiLinkId: string, options?: TagApiLinkDeleteOptionalParams): 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.

tagId

string

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

apiLinkId

string

Tag-API link identifier. Must be unique in the current API Management service instance.

options

TagApiLinkDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, TagApiLinkGetOptionalParams)

Gets the API link for the tag.

function get(resourceGroupName: string, serviceName: string, tagId: string, apiLinkId: string, options?: TagApiLinkGetOptionalParams): Promise<TagApiLinkGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

tagId

string

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

apiLinkId

string

Tag-API link identifier. Must be unique in the current API Management service instance.

options

TagApiLinkGetOptionalParams

The options parameters.

Returns

Promise<TagApiLinkGetResponse>

listByProduct(string, string, string, TagApiLinkListByProductOptionalParams)

Lists a collection of the API links associated with a tag.

function listByProduct(resourceGroupName: string, serviceName: string, tagId: string, options?: TagApiLinkListByProductOptionalParams): PagedAsyncIterableIterator<TagApiLinkContract, TagApiLinkContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

tagId

string

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

options

TagApiLinkListByProductOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagApiLinkContract, TagApiLinkContract[], PageSettings>