ApiManagementService interface
Interface representing a ApiManagementService.
Methods
| begin |
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes. |
| begin |
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes. |
| begin |
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. |
| begin |
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. |
| begin |
Creates or updates an API Management service. This is long running operation and could take several minutes to complete. |
| begin |
Creates or updates an API Management service. This is long running operation and could take several minutes to complete. |
| begin |
Deletes an existing API Management service. |
| begin |
Deletes an existing API Management service. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
Updates an existing API Management service. |
| begin |
Updates an existing API Management service. |
| check |
Checks availability and correctness of a name for an API Management service. |
| get(string, string, Api |
Gets an API Management service resource description. |
| get |
Get the custom domain ownership identifier for an API Management service. |
| get |
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. |
| list(Api |
Lists all API Management services within an Azure subscription. |
| list |
List all API Management services within a resource group. |
Method Details
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
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.
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters supplied to the ApiManagementService_Backup operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
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.
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters supplied to the ApiManagementService_Backup operation.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceResource
Parameters supplied to the CreateOrUpdate API Management service operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceResource
Parameters supplied to the CreateOrUpdate API Management service operation.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
Deletes an existing API Management service.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
Deletes an existing API Management service.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
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.
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
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.
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
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.
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters supplied to the Restore API Management service from backup operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
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.
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters supplied to the Restore API Management service from backup operation.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates an existing API Management service.
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceUpdateParameters
Parameters supplied to the CreateOrUpdate API Management service operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates an existing API Management service.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- parameters
- ApiManagementServiceUpdateParameters
Parameters supplied to the CreateOrUpdate API Management service operation.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
Checks availability and correctness of a name for an API Management service.
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>Parameters
Parameters supplied to the CheckNameAvailability operation.
The options parameters.
Returns
get(string, string, ApiManagementServiceGetOptionalParams)
Gets an API Management service resource description.
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
Get the custom domain ownership identifier for an API Management service.
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>Parameters
The options parameters.
Returns
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
list(ApiManagementServiceListOptionalParams)
Lists all API Management services within an Azure subscription.
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
List all API Management services within a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.