deleted_services

Creates, updates, deletes, gets or lists a deleted_services resource.

Overview

Name	deleted_services
Type	Resource
Id	azure.api_management.deleted_services

Fields

The following fields are returned by SELECT queries:

get_by_name

Soft-deleted Api Management Service.

Name	Datatype	Description
location	string	API Management Service Master Location.
properties	object	Deleted API Management Service details.

list_by_subscription

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

Name	Datatype	Description
location	string	API Management Service Master Location.
properties	object	Deleted API Management Service details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	serviceName, subscriptionId, location		Get soft-deleted Api Management Service by name.
list_by_subscription	select	subscriptionId		Lists all soft-deleted services available for undelete for the given subscription.
purge	exec	serviceName, subscriptionId, location		Purges Api Management Service (deletes it with no option to undelete).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	The location of the deleted API Management service.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get_by_name

Get soft-deleted Api Management Service by name.

SELECT
location,
properties
FROM azure.api_management.deleted_services
WHERE serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
;

list_by_subscription

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

SELECT
location,
properties
FROM azure.api_management.deleted_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

Lifecycle Methods

purge

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

EXEC azure.api_management.deleted_services.purge 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required
;