DeletedServicesImpl | @azure/arm-apimanagement

Class containing DeletedServices operations.

Hierarchy

DeletedServicesImpl

Implements

DeletedServices

Index

Constructors

constructor

Methods

Constructors

constructor

new DeletedServicesImpl(client: ApiManagementClientContext): DeletedServicesImpl

- Defined in operations/deletedServices.ts:31
Initialize a new instance of the class DeletedServices class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns DeletedServicesImpl

Methods

beginPurge

beginPurge(serviceName: string, location: string, options?: DeletedServicesPurgeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of DeletedServices.beginPurge
- Defined in operations/deletedServices.ts:119
Purges Api Management Service (deletes it with no option to undelete).

Parameters
- serviceName: string
  
  The name of the API Management service.
- location: string
  
  The location of the deleted API Management service.
- Optional options: DeletedServicesPurgeOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPurgeAndWait

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

Implementation of DeletedServices.beginPurgeAndWait
- Defined in operations/deletedServices.ts:181
Purges Api Management Service (deletes it with no option to undelete).

Parameters
- serviceName: string
  
  The name of the API Management service.
- location: string
  
  The location of the deleted API Management service.
- Optional options: DeletedServicesPurgeOptionalParams
  
  The options parameters.
Returns Promise<void>

getByName

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

Implementation of DeletedServices.getByName
- Defined in operations/deletedServices.ts:102
Get soft-deleted Api Management Service by name.

Parameters
- serviceName: string
  
  The name of the API Management service.
- location: string
  
  The location of the deleted API Management service.
- Optional options: DeletedServicesGetByNameOptionalParams
  
  The options parameters.
Returns Promise<DeletedServicesGetByNameResponse>

listBySubscription

listBySubscription(options?: DeletedServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DeletedServiceContract>

Implementation of DeletedServices.listBySubscription
- Defined in operations/deletedServices.ts:45
Lists all soft-deleted services available for undelete for the given subscription.

Parameters
- Optional options: DeletedServicesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeletedServiceContract>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns DeletedServicesImpl

Methods

beginPurge

Parameters

serviceName: string

location: string

Optional options: DeletedServicesPurgeOptionalParams

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

beginPurgeAndWait

Parameters

serviceName: string

location: string

Optional options: DeletedServicesPurgeOptionalParams

Returns Promise<void>

getByName

Parameters

serviceName: string

location: string

Optional options: DeletedServicesGetByNameOptionalParams

Returns Promise<DeletedServicesGetByNameResponse>

listBySubscription

Parameters

Optional options: DeletedServicesListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<DeletedServiceContract>