ApiManagementService | @azure/arm-apimanagement

Interface representing a ApiManagementService.

Hierarchy

ApiManagementService

Implemented by

ApiManagementServiceImpl

Index

Methods

beginApplyNetworkConfigurationUpdates

beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>, ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>>

- Defined in operationsInterfaces/apiManagementService.ts:257
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>, ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>>

beginApplyNetworkConfigurationUpdatesAndWait

beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>

- Defined in operationsInterfaces/apiManagementService.ts:276
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>

beginBackup

beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementServiceBackupResponse>, ApiManagementServiceBackupResponse>>

- Defined in operationsInterfaces/apiManagementService.ts:101
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceBackupRestoreParameters
  
  Parameters supplied to the ApiManagementService_Backup operation.
- Optional options: ApiManagementServiceBackupOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiManagementServiceBackupResponse>, ApiManagementServiceBackupResponse>>

beginBackupAndWait

beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceBackupResponse>

- Defined in operationsInterfaces/apiManagementService.ts:120
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceBackupRestoreParameters
  
  Parameters supplied to the ApiManagementService_Backup operation.
- Optional options: ApiManagementServiceBackupOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceBackupResponse>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementServiceCreateOrUpdateResponse>, ApiManagementServiceCreateOrUpdateResponse>>

- Defined in operationsInterfaces/apiManagementService.ts:134
Creates or updates an API Management service. This is long running operation and could take several minutes to complete.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceResource
  
  Parameters supplied to the CreateOrUpdate API Management service operation.
- Optional options: ApiManagementServiceCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiManagementServiceCreateOrUpdateResponse>, ApiManagementServiceCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceCreateOrUpdateResponse>

- Defined in operationsInterfaces/apiManagementService.ts:153
Creates or updates an API Management service. This is long running operation and could take several minutes to complete.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceResource
  
  Parameters supplied to the CreateOrUpdate API Management service operation.
- Optional options: ApiManagementServiceCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/apiManagementService.ts:207
Deletes an existing API Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/apiManagementService.ts:218
Deletes an existing API Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestore

beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementServiceRestoreResponse>, ApiManagementServiceRestoreResponse>>

- Defined in operationsInterfaces/apiManagementService.ts:67
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceBackupRestoreParameters
  
  Parameters supplied to the Restore API Management service from backup operation.
- Optional options: ApiManagementServiceRestoreOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiManagementServiceRestoreResponse>, ApiManagementServiceRestoreResponse>>

beginRestoreAndWait

beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceRestoreResponse>

- Defined in operationsInterfaces/apiManagementService.ts:87
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceBackupRestoreParameters
  
  Parameters supplied to the Restore API Management service from backup operation.
- Optional options: ApiManagementServiceRestoreOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceRestoreResponse>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementServiceUpdateResponse>, ApiManagementServiceUpdateResponse>>

- Defined in operationsInterfaces/apiManagementService.ts:166
Updates an existing API Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceUpdateParameters
  
  Parameters supplied to the CreateOrUpdate API Management service operation.
- Optional options: ApiManagementServiceUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiManagementServiceUpdateResponse>, ApiManagementServiceUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceUpdateResponse>

- Defined in operationsInterfaces/apiManagementService.ts:184
Updates an existing API Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: ApiManagementServiceUpdateParameters
  
  Parameters supplied to the CreateOrUpdate API Management service operation.
- Optional options: ApiManagementServiceUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceUpdateResponse>

checkNameAvailability

checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceCheckNameAvailabilityResponse>

- Defined in operationsInterfaces/apiManagementService.ts:239
Checks availability and correctness of a name for an API Management service.

Parameters
- parameters: ApiManagementServiceCheckNameAvailabilityParameters
  
  Parameters supplied to the CheckNameAvailability operation.
- Optional options: ApiManagementServiceCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceCheckNameAvailabilityResponse>

get

get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceGetResponse>

- Defined in operationsInterfaces/apiManagementService.ts:196
Gets an API Management service resource description.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceGetOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceGetResponse>

getDomainOwnershipIdentifier

getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResponse>

- Defined in operationsInterfaces/apiManagementService.ts:247
Get the custom domain ownership identifier for an API Management service.

Parameters
- Optional options: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceGetDomainOwnershipIdentifierResponse>

getSsoToken

getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResponse>

- Defined in operationsInterfaces/apiManagementService.ts:229
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiManagementServiceGetSsoTokenOptionalParams
  
  The options parameters.
Returns Promise<ApiManagementServiceGetSsoTokenResponse>

list

list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource>

- Defined in operationsInterfaces/apiManagementService.ts:55
Lists all API Management services within an Azure subscription.

Parameters
- Optional options: ApiManagementServiceListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiManagementServiceResource>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource>

- Defined in operationsInterfaces/apiManagementService.ts:47
List all API Management services within a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: ApiManagementServiceListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiManagementServiceResource>

Hierarchy

Implemented by

Index

Methods

Methods

beginApplyNetworkConfigurationUpdates

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>, ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>>

beginApplyNetworkConfigurationUpdatesAndWait

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Returns Promise<ApiManagementServiceApplyNetworkConfigurationUpdatesResponse>

beginBackup

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceBackupRestoreParameters

Optional options: ApiManagementServiceBackupOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiManagementServiceBackupResponse>, ApiManagementServiceBackupResponse>>

beginBackupAndWait

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceBackupRestoreParameters

Optional options: ApiManagementServiceBackupOptionalParams

Returns Promise<ApiManagementServiceBackupResponse>

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceResource

Optional options: ApiManagementServiceCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiManagementServiceCreateOrUpdateResponse>, ApiManagementServiceCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceResource

Optional options: ApiManagementServiceCreateOrUpdateOptionalParams

Returns Promise<ApiManagementServiceCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiManagementServiceDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiManagementServiceDeleteOptionalParams

Returns Promise<void>

beginRestore

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceBackupRestoreParameters

Optional options: ApiManagementServiceRestoreOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiManagementServiceRestoreResponse>, ApiManagementServiceRestoreResponse>>

beginRestoreAndWait

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceBackupRestoreParameters

Optional options: ApiManagementServiceRestoreOptionalParams

Returns Promise<ApiManagementServiceRestoreResponse>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

parameters: ApiManagementServiceUpdateParameters

Optional options: ApiManagementServiceUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiManagementServiceUpdateResponse>, ApiManagementServiceUpdateResponse>>

beginUpdateAndWait

Parameters