Package com.azure.resourcemanager.apimanagement.models

Interface ApiManagementServices

public interface ApiManagementServices

Resource collection API of ApiManagementServices.

Method Summary

Modifier and Type	Method	Description
ApiManagementServiceResource	applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName)	Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
ApiManagementServiceResource	applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName, ApiManagementServiceApplyNetworkConfigurationParameters parameters)	Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
ApiManagementServiceResource	applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName, ApiManagementServiceApplyNetworkConfigurationParameters parameters, com.azure.core.util.Context context)	Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
ApiManagementServiceResource	backup(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)	Creates a backup of the API Management service to the given Azure Storage Account.
ApiManagementServiceResource	backup(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters, com.azure.core.util.Context context)	Creates a backup of the API Management service to the given Azure Storage Account.
ApiManagementServiceNameAvailabilityResult	checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters parameters)	Checks availability and correctness of a name for an API Management service.
com.azure.core.http.rest.Response<ApiManagementServiceNameAvailabilityResult>	checkNameAvailabilityWithResponse(ApiManagementServiceCheckNameAvailabilityParameters parameters, com.azure.core.util.Context context)	Checks availability and correctness of a name for an API Management service.
ApiManagementServiceResource.DefinitionStages.Blank	define(String name)	Begins definition for a new ApiManagementServiceResource resource.
ApiManagementServiceResource	delete(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Deletes an existing API Management service.
ApiManagementServiceResource	deleteById(String id)	Deletes an existing API Management service.
ApiManagementServiceResource	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes an existing API Management service.
ApiManagementServiceResource	deleteByResourceGroup(String resourceGroupName, String serviceName)	Deletes an existing API Management service.
ApiManagementServiceResource	getById(String id)	Gets an API Management service resource description.
com.azure.core.http.rest.Response<ApiManagementServiceResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets an API Management service resource description.
ApiManagementServiceResource	getByResourceGroup(String resourceGroupName, String serviceName)	Gets an API Management service resource description.
com.azure.core.http.rest.Response<ApiManagementServiceResource>	getByResourceGroupWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Gets an API Management service resource description.
ApiManagementServiceGetDomainOwnershipIdentifierResult	getDomainOwnershipIdentifier()	Get the custom domain ownership identifier for an API Management service.
com.azure.core.http.rest.Response<ApiManagementServiceGetDomainOwnershipIdentifierResult>	getDomainOwnershipIdentifierWithResponse(com.azure.core.util.Context context)	Get the custom domain ownership identifier for an API Management service.
ApiManagementServiceGetSsoTokenResult	getSsoToken(String resourceGroupName, String serviceName)	Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
com.azure.core.http.rest.Response<ApiManagementServiceGetSsoTokenResult>	getSsoTokenWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource>	list()	Lists all API Management services within an Azure subscription.
com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource>	list(com.azure.core.util.Context context)	Lists all API Management services within an Azure subscription.
com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource>	listByResourceGroup(String resourceGroupName)	List all API Management services within a resource group.
com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List all API Management services within a resource group.
ApiManagementServiceResource	restore(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)	Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service.
ApiManagementServiceResource	restore(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters, com.azure.core.util.Context context)	Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service.

Method Detail

restore

ApiManagementServiceResource restore(String resourceGroupName,
                                     String serviceName,
                                     ApiManagementServiceBackupRestoreParameters parameters)

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the Restore API Management service from backup operation.

Returns:

a single API Management service resource in List or Get 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.

restore

ApiManagementServiceResource restore(String resourceGroupName,
                                     String serviceName,
                                     ApiManagementServiceBackupRestoreParameters parameters,
                                     com.azure.core.util.Context context)

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the Restore API Management service from backup operation.

context - The context to associate with this operation.

Returns:

a single API Management service resource in List or Get 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.

backup

ApiManagementServiceResource backup(String resourceGroupName,
                                    String serviceName,
                                    ApiManagementServiceBackupRestoreParameters parameters)

Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the ApiManagementService_Backup operation.

Returns:

a single API Management service resource in List or Get 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.

backup

ApiManagementServiceResource backup(String resourceGroupName,
                                    String serviceName,
                                    ApiManagementServiceBackupRestoreParameters parameters,
                                    com.azure.core.util.Context context)

Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the ApiManagementService_Backup operation.

context - The context to associate with this operation.

Returns:

a single API Management service resource in List or Get 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.

getByResourceGroup

ApiManagementServiceResource getByResourceGroup(String resourceGroupName,
                                                String serviceName)

Gets an API Management service resource description.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

an API Management service resource description.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ApiManagementServiceResource> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                               String serviceName,
                                                                                               com.azure.core.util.Context context)

Gets an API Management service resource description.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

an API Management service resource description along with 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.

deleteByResourceGroup

ApiManagementServiceResource deleteByResourceGroup(String resourceGroupName,
                                                   String serviceName)

Deletes an existing API Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

delete

ApiManagementServiceResource delete(String resourceGroupName,
                                    String serviceName,
                                    com.azure.core.util.Context context)

Deletes an existing API Management service.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource> listByResourceGroup(String resourceGroupName)

List all API Management services within a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the response of the List API Management services operation 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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource> listByResourceGroup(String resourceGroupName,
                                                                                         com.azure.core.util.Context context)

List all API Management services within a resource group.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

the response of the List API Management services operation 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.

list

com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource> list()

Lists all API Management services within an Azure subscription.

Returns:

the response of the List API Management services operation as paginated response with PagedIterable.

Throws:

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.

list

com.azure.core.http.rest.PagedIterable<ApiManagementServiceResource> list(com.azure.core.util.Context context)

Lists all API Management services within an Azure subscription.

Parameters:

context - The context to associate with this operation.

Returns:

the response of the List API Management services operation 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.

getSsoToken

ApiManagementServiceGetSsoTokenResult getSsoToken(String resourceGroupName,
                                                  String serviceName)

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

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.

getSsoTokenWithResponse

com.azure.core.http.rest.Response<ApiManagementServiceGetSsoTokenResult> getSsoTokenWithResponse(String resourceGroupName,
                                                                                                 String serviceName,
                                                                                                 com.azure.core.util.Context context)

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

the Single-Sign-On token for the API Management Service which is valid for 5 Minutes along with 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.

checkNameAvailability

ApiManagementServiceNameAvailabilityResult checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters parameters)

Checks availability and correctness of a name for an API Management service.

Parameters:

parameters - Parameters supplied to the CheckNameAvailability operation.

Returns:

response of the CheckNameAvailability operation.

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.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<ApiManagementServiceNameAvailabilityResult> checkNameAvailabilityWithResponse(ApiManagementServiceCheckNameAvailabilityParameters parameters,
                                                                                                                com.azure.core.util.Context context)

Checks availability and correctness of a name for an API Management service.

Parameters:

parameters - Parameters supplied to the CheckNameAvailability operation.

context - The context to associate with this operation.

Returns:

response of the CheckNameAvailability operation along with 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.

getDomainOwnershipIdentifier

ApiManagementServiceGetDomainOwnershipIdentifierResult getDomainOwnershipIdentifier()

Get the custom domain ownership identifier for an API Management service.

Returns:

the custom domain ownership identifier for an API Management service.

Throws:

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.

getDomainOwnershipIdentifierWithResponse

com.azure.core.http.rest.Response<ApiManagementServiceGetDomainOwnershipIdentifierResult> getDomainOwnershipIdentifierWithResponse(com.azure.core.util.Context context)

Get the custom domain ownership identifier for an API Management service.

Parameters:

context - The context to associate with this operation.

Returns:

the custom domain ownership identifier for an API Management service along with 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.

applyNetworkConfigurationUpdates

ApiManagementServiceResource applyNetworkConfigurationUpdates(String resourceGroupName,
                                                              String serviceName,
                                                              ApiManagementServiceApplyNetworkConfigurationParameters parameters)

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.

Returns:

a single API Management service resource in List or Get 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.

applyNetworkConfigurationUpdates

ApiManagementServiceResource applyNetworkConfigurationUpdates(String resourceGroupName,
                                                              String serviceName)

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

a single API Management service resource in List or Get 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.

applyNetworkConfigurationUpdates

ApiManagementServiceResource applyNetworkConfigurationUpdates(String resourceGroupName,
                                                              String serviceName,
                                                              ApiManagementServiceApplyNetworkConfigurationParameters parameters,
                                                              com.azure.core.util.Context context)

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.

context - The context to associate with this operation.

Returns:

a single API Management service resource in List or Get 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

ApiManagementServiceResource getById(String id)

Gets an API Management service resource description.

Parameters:

id - the resource ID.

Returns:

an API Management service resource description along with 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.

getByIdWithResponse

com.azure.core.http.rest.Response<ApiManagementServiceResource> getByIdWithResponse(String id,
                                                                                    com.azure.core.util.Context context)

Gets an API Management service resource description.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

an API Management service resource description along with 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.

deleteById

ApiManagementServiceResource deleteById(String id)

Deletes an existing API Management service.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

ApiManagementServiceResource deleteByIdWithResponse(String id,
                                                    com.azure.core.util.Context context)

Deletes an existing API Management service.

Parameters:

id - the resource ID.

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

ApiManagementServiceResource.DefinitionStages.Blank define(String name)

Begins definition for a new ApiManagementServiceResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ApiManagementServiceResource definition.