ApiTagDescriptions Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface ApiTagDescriptions

Resource collection API of ApiTagDescriptions.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new TagDescriptionContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch) Delete tag description for the Api.
abstract void	deleteById(String id) Delete tag description for the Api.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Delete tag description for the Api.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch, Context context) Delete tag description for the Api.
abstract TagDescriptionContract	get(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId) Get Tag description in scope of API.
abstract TagDescriptionContract	getById(String id) Get Tag description in scope of API.
abstract Response<TagDescriptionContract>	getByIdWithResponse(String id, Context context) Get Tag description in scope of API.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId) Gets the entity state version of the tag specified by its identifier.
abstract ApiTagDescriptionsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, Context context) Gets the entity state version of the tag specified by its identifier.
abstract Response<TagDescriptionContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, Context context) Get Tag description in scope of API.
abstract PagedIterable<TagDescriptionContract>	listByService(String resourceGroupName, String serviceName, String apiId) Lists all Tags descriptions in scope of API.
abstract PagedIterable<TagDescriptionContract>	listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, Context context) Lists all Tags descriptions in scope of API.

Method Details

define

public abstract TagDescriptionContract.DefinitionStages.Blank define(String name)

Begins definition for a new TagDescriptionContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new TagDescriptionContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch)

Delete tag description for the Api.

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

ifMatch - 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.

deleteById

public abstract void deleteById(String id)

Delete tag description for the Api.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Delete tag description for the Api.

Parameters:

id - the resource ID.

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch, Context context)

Delete tag description for the Api.

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract TagDescriptionContract get(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId)

Get Tag description in scope of API.

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

Returns:

tag description in scope of API.

getById

public abstract TagDescriptionContract getById(String id)

Get Tag description in scope of API.

Parameters:

id - the resource ID.

Returns:

tag description in scope of API.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get Tag description in scope of API.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

tag description in scope of API.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId)

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

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

getEntityTagWithResponse

public abstract ApiTagDescriptionsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, Context context)

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

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, Context context)

Get Tag description in scope of API.

Parameters:

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

serviceName - The name of the API Management service.

apiId - 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 - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

context - The context to associate with this operation.

Returns:

tag description in scope of API.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId)

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 - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - 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.

Returns:

paged TagDescription list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, Context context)

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 - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - 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.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged TagDescription list representation as paginated response with PagedIterable<T>.