Interface ApiTagDescriptions
-
public interface ApiTagDescriptions
Resource collection API of ApiTagDescriptions.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TagDescriptionContract.DefinitionStages.Blank
define(String name)
Begins definition for a new TagDescriptionContract resource.void
delete(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch)
Delete tag description for the Api.void
deleteById(String id)
Delete tag description for the Api.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
Delete tag description for the Api.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch, com.azure.core.util.Context context)
Delete tag description for the Api.TagDescriptionContract
get(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId)
Get Tag description in scope of API.TagDescriptionContract
getById(String id)
Get Tag description in scope of API.com.azure.core.http.rest.Response<TagDescriptionContract>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Get Tag description in scope of API.void
getEntityTag(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId)
Gets the entity state version of the tag specified by its identifier.ApiTagDescriptionsGetEntityTagResponse
getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, com.azure.core.util.Context context)
Gets the entity state version of the tag specified by its identifier.com.azure.core.http.rest.Response<TagDescriptionContract>
getWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, com.azure.core.util.Context context)
Get Tag description in scope of API.com.azure.core.http.rest.PagedIterable<TagDescriptionContract>
listByService(String resourceGroupName, String serviceName, String apiId)
Lists all Tags descriptions in scope of API.com.azure.core.http.rest.PagedIterable<TagDescriptionContract>
listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
Lists all Tags descriptions in scope of API.
-
-
-
Method Detail
-
listByService
com.azure.core.http.rest.PagedIterable<TagDescriptionContract> 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.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByService
com.azure.core.http.rest.PagedIterable<TagDescriptionContract> listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.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.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getEntityTag
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.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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getEntityTagWithResponse
ApiTagDescriptionsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, com.azure.core.util.Context context)
Gets the entity state version of the tag specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
get
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.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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getWithResponse
com.azure.core.http.rest.Response<TagDescriptionContract> getWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, com.azure.core.util.Context context)
Get Tag description in scope of API.- Parameters:
resourceGroupName
- The name of the resource group.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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
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.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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String tagDescriptionId, String ifMatch, com.azure.core.util.Context context)
Delete tag description for the Api.- Parameters:
resourceGroupName
- The name of the resource group.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
TagDescriptionContract getById(String id)
Get Tag description in scope of API.- Parameters:
id
- the resource ID.- Returns:
- tag description in scope of API.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByIdWithResponse
com.azure.core.http.rest.Response<TagDescriptionContract> getByIdWithResponse(String id, com.azure.core.util.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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
void deleteById(String id)
Delete tag description for the Api.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
define
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.
-
-