DeletedServices interface

Package:

@azure/arm-apimanagement

Interface representing a DeletedServices.

Methods

beginPurge(string, string, DeletedServicesPurgeOptionalParams)	Purges Api Management Service (deletes it with no option to undelete).
beginPurgeAndWait(string, string, DeletedServicesPurgeOptionalParams)	Purges Api Management Service (deletes it with no option to undelete).
getByName(string, string, DeletedServicesGetByNameOptionalParams)	Get soft-deleted Api Management Service by name.
listBySubscription(DeletedServicesListBySubscriptionOptionalParams)	Lists all soft-deleted services available for undelete for the given subscription.

Method Details

beginPurge(string, string, DeletedServicesPurgeOptionalParams)

Purges Api Management Service (deletes it with no option to undelete).

function beginPurge(serviceName: string, location: string, options?: DeletedServicesPurgeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

serviceName

string

The name of the API Management service.

location

string

The location of the deleted API Management service.

options

DeletedServicesPurgeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginPurgeAndWait(string, string, DeletedServicesPurgeOptionalParams)

Purges Api Management Service (deletes it with no option to undelete).

function beginPurgeAndWait(serviceName: string, location: string, options?: DeletedServicesPurgeOptionalParams): Promise<void>

Parameters

serviceName

string

The name of the API Management service.

location

string

The location of the deleted API Management service.

options

DeletedServicesPurgeOptionalParams

The options parameters.

Returns

Promise<void>

getByName(string, string, DeletedServicesGetByNameOptionalParams)

Get soft-deleted Api Management Service by name.

function getByName(serviceName: string, location: string, options?: DeletedServicesGetByNameOptionalParams): Promise<DeletedServiceContract>

Parameters

serviceName

string

The name of the API Management service.

location

string

The location of the deleted API Management service.

options

DeletedServicesGetByNameOptionalParams

The options parameters.

Returns

Promise<DeletedServiceContract>

listBySubscription(DeletedServicesListBySubscriptionOptionalParams)

Lists all soft-deleted services available for undelete for the given subscription.

function listBySubscription(options?: DeletedServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DeletedServiceContract, DeletedServiceContract[], PageSettings>

Parameters

options

DeletedServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeletedServiceContract, DeletedServiceContract[], PageSettings>