Interface ApiManagementServicesClient
-
public interface ApiManagementServicesClient
An instance of this class provides access to all the operations defined in ApiManagementServicesClient.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ApiManagementServiceResourceInner
applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.ApiManagementServiceResourceInner
applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName, ApiManagementServiceApplyNetworkConfigurationParameters parameters)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.ApiManagementServiceResourceInner
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.ApiManagementServiceResourceInner
backup(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)
Creates a backup of the API Management service to the given Azure Storage Account.ApiManagementServiceResourceInner
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.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginApplyNetworkConfigurationUpdates(String resourceGroupName, String serviceName, ApiManagementServiceApplyNetworkConfigurationParameters parameters)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginApplyNetworkConfigurationUpdates(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.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginBackup(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)
Creates a backup of the API Management service to the given Azure Storage Account.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginBackup(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.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginCreateOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)
Creates or updates an API Management service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginCreateOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters, com.azure.core.util.Context context)
Creates or updates an API Management service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginDelete(String resourceGroupName, String serviceName)
Deletes an existing API Management service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginDelete(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
Deletes an existing API Management service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginRestore(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)
Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginRestore(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.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginUpdate(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)
Updates an existing API Management service.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner>
beginUpdate(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters, com.azure.core.util.Context context)
Updates an existing API Management service.ApiManagementServiceNameAvailabilityResultInner
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters parameters)
Checks availability and correctness of a name for an API Management service.com.azure.core.http.rest.Response<ApiManagementServiceNameAvailabilityResultInner>
checkNameAvailabilityWithResponse(ApiManagementServiceCheckNameAvailabilityParameters parameters, com.azure.core.util.Context context)
Checks availability and correctness of a name for an API Management service.ApiManagementServiceResourceInner
createOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)
Creates or updates an API Management service.ApiManagementServiceResourceInner
createOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters, com.azure.core.util.Context context)
Creates or updates an API Management service.ApiManagementServiceResourceInner
delete(String resourceGroupName, String serviceName)
Deletes an existing API Management service.ApiManagementServiceResourceInner
delete(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
Deletes an existing API Management service.ApiManagementServiceResourceInner
getByResourceGroup(String resourceGroupName, String serviceName)
Gets an API Management service resource description.com.azure.core.http.rest.Response<ApiManagementServiceResourceInner>
getByResourceGroupWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
Gets an API Management service resource description.ApiManagementServiceGetDomainOwnershipIdentifierResultInner
getDomainOwnershipIdentifier()
Get the custom domain ownership identifier for an API Management service.com.azure.core.http.rest.Response<ApiManagementServiceGetDomainOwnershipIdentifierResultInner>
getDomainOwnershipIdentifierWithResponse(com.azure.core.util.Context context)
Get the custom domain ownership identifier for an API Management service.ApiManagementServiceGetSsoTokenResultInner
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<ApiManagementServiceGetSsoTokenResultInner>
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<ApiManagementServiceResourceInner>
list()
Lists all API Management services within an Azure subscription.com.azure.core.http.rest.PagedIterable<ApiManagementServiceResourceInner>
list(com.azure.core.util.Context context)
Lists all API Management services within an Azure subscription.com.azure.core.http.rest.PagedIterable<ApiManagementServiceResourceInner>
listByResourceGroup(String resourceGroupName)
List all API Management services within a resource group.com.azure.core.http.rest.PagedIterable<ApiManagementServiceResourceInner>
listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
List all API Management services within a resource group.ApiManagementServiceResourceInner
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.ApiManagementServiceResourceInner
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.ApiManagementServiceResourceInner
update(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)
Updates an existing API Management service.ApiManagementServiceResourceInner
update(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters, com.azure.core.util.Context context)
Updates an existing API Management service.
-
-
-
Method Detail
-
beginRestore
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginRestore(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:
- the
SyncPoller
for polling of 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.
-
beginRestore
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginRestore(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:
- the
SyncPoller
for polling of 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
ApiManagementServiceResourceInner 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
ApiManagementServiceResourceInner 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.
-
beginBackup
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginBackup(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:
- the
SyncPoller
for polling of 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.
-
beginBackup
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginBackup(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:
- the
SyncPoller
for polling of 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
ApiManagementServiceResourceInner 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
ApiManagementServiceResourceInner 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)
Creates or updates an API Management service. 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 CreateOrUpdate API Management service operation.- Returns:
- the
SyncPoller
for polling of 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters, com.azure.core.util.Context context)
Creates or updates an API Management service. 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 CreateOrUpdate API Management service operation.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of 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.
-
createOrUpdate
ApiManagementServiceResourceInner createOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)
Creates or updates an API Management service. 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 CreateOrUpdate API Management service 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.
-
createOrUpdate
ApiManagementServiceResourceInner createOrUpdate(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters, com.azure.core.util.Context context)
Creates or updates an API Management service. 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 CreateOrUpdate API Management service 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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginUpdate(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)
Updates an existing API Management service.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.parameters
- Parameters supplied to the CreateOrUpdate API Management service operation.- Returns:
- the
SyncPoller
for polling of 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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginUpdate(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters, com.azure.core.util.Context context)
Updates an existing API Management service.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.parameters
- Parameters supplied to the CreateOrUpdate API Management service operation.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of 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.
-
update
ApiManagementServiceResourceInner update(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)
Updates an existing API Management service.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.parameters
- Parameters supplied to the CreateOrUpdate API Management service 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.
-
update
ApiManagementServiceResourceInner update(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters, com.azure.core.util.Context context)
Updates an existing API Management service.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.parameters
- Parameters supplied to the CreateOrUpdate API Management service 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
ApiManagementServiceResourceInner 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<ApiManagementServiceResourceInner> 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginDelete(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
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginDelete(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
SyncPoller
for polling of long-running 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.
-
delete
ApiManagementServiceResourceInner delete(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
ApiManagementServiceResourceInner 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<ApiManagementServiceResourceInner> 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<ApiManagementServiceResourceInner> 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<ApiManagementServiceResourceInner> 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<ApiManagementServiceResourceInner> 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
ApiManagementServiceGetSsoTokenResultInner 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<ApiManagementServiceGetSsoTokenResultInner> 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
ApiManagementServiceNameAvailabilityResultInner 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<ApiManagementServiceNameAvailabilityResultInner> 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
ApiManagementServiceGetDomainOwnershipIdentifierResultInner 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<ApiManagementServiceGetDomainOwnershipIdentifierResultInner> 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.
-
beginApplyNetworkConfigurationUpdates
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginApplyNetworkConfigurationUpdates(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:
- the
SyncPoller
for polling of 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.
-
beginApplyNetworkConfigurationUpdates
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementServiceResourceInner>,ApiManagementServiceResourceInner> beginApplyNetworkConfigurationUpdates(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:
- the
SyncPoller
for polling of 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
ApiManagementServiceResourceInner 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
ApiManagementServiceResourceInner 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
ApiManagementServiceResourceInner 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.
-
-