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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deletionDate	string (date-time)	UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
location	string	API Management Service Master Location.
scheduledPurgeDate	string (date-time)	UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
serviceId	string	Fully-qualified API Management Service Resource ID.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deletionDate	string (date-time)	UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
location	string	API Management Service Master Location.
scheduledPurgeDate	string (date-time)	UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
serviceId	string	Fully-qualified API Management Service Resource ID.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	service_name, location, subscription_id		Get soft-deleted Api Management Service by name.
list_by_subscription	select	subscription_id		Lists all soft-deleted services available for undelete for the given subscription.
purge	delete	service_name, location, subscription_id		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 name of the Azure region. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string

SELECT examples

get_by_name

Get soft-deleted Api Management Service by name.

SELECT
id,
name,
deletionDate,
location,
scheduledPurgeDate,
serviceId,
systemData,
type
FROM azure.api_management.deleted_services
WHERE service_name = '{{ service_name }}' -- required
AND location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
deletionDate,
location,
scheduledPurgeDate,
serviceId,
systemData,
type
FROM azure.api_management.deleted_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

purge

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

DELETE FROM azure.api_management.deleted_services
WHERE service_name = '{{ service_name }}' --required
AND location = '{{ location }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;