deleted_accounts

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

Overview

Name	deleted_accounts
Type	Resource
Id	azure.cognitive_services.deleted_accounts

Fields

The following fields are returned by SELECT queries:

get

The resource provider should return 200 (OK) to indicate that the operation completed successfully.
For a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are "name," "type" and "id."
Field Description
Kind required. String.
The API set for this API account. It can be
· a single API, for example: Face API, Vision API, Speech API.
a bundle of APIs: Face + Speech, Vision + Emotion, etc.
sku.name Required.
The pricing tier/plan of this API. Could be:
F0 - Free
B0 - Basic
S0 - Standard
P0 - Premium

Name	Datatype	Description
etag	string	Resource Etag.
identity	object	Identity for the resource.
kind	string	The Kind of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of Cognitive Services account.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.
For a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section.

Name	Datatype	Description
etag	string	Resource Etag.
identity	object	Identity for the resource.
kind	string	The Kind of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of Cognitive Services account.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, resourceGroupName, accountName, subscriptionId		Returns a Cognitive Services account specified by the parameters.
list	select	subscriptionId		Returns all the resources of a particular type belonging to a subscription.
purge	exec	location, resourceGroupName, accountName, subscriptionId		Deletes a Cognitive Services account from the resource group.

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
accountName	string	The name of Cognitive Services account.
location	string	Resource location.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns a Cognitive Services account specified by the parameters.

SELECT
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.cognitive_services.deleted_accounts
WHERE location = '{{ location }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Returns all the resources of a particular type belonging to a subscription.

SELECT
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.cognitive_services.deleted_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

Lifecycle Methods

purge

Deletes a Cognitive Services account from the resource group.

EXEC azure.cognitive_services.deleted_accounts.purge 
@location='{{ location }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;