ApiManagementServices Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiManagementServices

Resource collection API of ApiManagementServices.

Method Summary

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

Method Details

applyNetworkConfigurationUpdates

public abstract 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. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

a single API Management service resource in List or Get response.

applyNetworkConfigurationUpdates

public abstract ApiManagementServiceResource applyNetworkConfigurationUpdates(String resourceGroupName, String serviceName, ApiManagementServiceApplyNetworkConfigurationParameters parameters, 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. The name is case insensitive.

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.

backup

public abstract 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. The name is case insensitive.

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.

backup

public abstract ApiManagementServiceResource backup(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters, 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. The name is case insensitive.

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.

checkNameAvailability

public abstract 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.

checkNameAvailabilityWithResponse

public abstract Response checkNameAvailabilityWithResponse(ApiManagementServiceCheckNameAvailabilityParameters parameters, 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<T>.

define

public abstract 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.

delete

public abstract ApiManagementServiceResource delete(String resourceGroupName, String serviceName, Context context)

Deletes an existing API Management service.

Parameters:

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

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

the response.

deleteById

public abstract ApiManagementServiceResource deleteById(String id)

Deletes an existing API Management service.

Parameters:

id - the resource ID.

Returns:

the response.

deleteByIdWithResponse

public abstract ApiManagementServiceResource deleteByIdWithResponse(String id, Context context)

Deletes an existing API Management service.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the response.

deleteByResourceGroup

public abstract ApiManagementServiceResource deleteByResourceGroup(String resourceGroupName, String serviceName)

Deletes an existing API Management service.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

the response.

getById

public abstract 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<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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<T>.

getByResourceGroup

public abstract ApiManagementServiceResource getByResourceGroup(String resourceGroupName, String serviceName)

Gets an API Management service resource description.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

an API Management service resource description.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String serviceName, Context context)

Gets an API Management service resource description.

Parameters:

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

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

getDomainOwnershipIdentifier

public abstract ApiManagementServiceGetDomainOwnershipIdentifierResult getDomainOwnershipIdentifier()

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

Returns:

the custom domain ownership identifier for an API Management service.

getDomainOwnershipIdentifierWithResponse

public abstract Response getDomainOwnershipIdentifierWithResponse(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<T>.

getSsoToken

public abstract 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. The name is case insensitive.

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.

getSsoTokenWithResponse

public abstract Response getSsoTokenWithResponse(String resourceGroupName, String serviceName, 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. The name is case insensitive.

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

list

public abstract PagedIterable 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<T>.

list

public abstract PagedIterable list(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<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

List all API Management services within a resource group.

Parameters:

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

Returns:

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

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, Context context)

List all API Management services within a resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

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

migrateToStv2

public abstract ApiManagementServiceResource migrateToStv2(String resourceGroupName, String serviceName)

Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

a single API Management service resource in List or Get response.

migrateToStv2

public abstract ApiManagementServiceResource migrateToStv2(String resourceGroupName, String serviceName, Context context)

Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.

Parameters:

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

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

a single API Management service resource in List or Get response.

restore

public abstract 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. The name is case insensitive.

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.

restore

public abstract ApiManagementServiceResource restore(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters, 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. The name is case insensitive.

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.