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
list

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.
`abusePenalty`	`object`	The abuse penalty.
`allowProjectManagement`	`boolean`	Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry.
`allowedFqdnList`	`array`	:vartype allowed_fqdn_list: list[str]
`amlWorkspace`	`object`	The user owned AML account properties.
`apiProperties`	`object`	The api properties for special APIs.
`associatedProjects`	`array`	Specifies the projects, by project name, that are associated with this resource.
`callRateLimit`	`object`	The call rate limit Cognitive Services account.
`capabilities`	`array`	Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.
`commitmentPlanAssociations`	`array`	The commitment plan associations of Cognitive Services account.
`customSubDomainName`	`string`	Optional subdomain name used for token-based authentication.
`dateCreated`	`string`	Gets the date of cognitive services account creation.
`defaultProject`	`string`	Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter.
`deletionDate`	`string`	The deletion date, only available for deleted account.
`disableLocalAuth`	`boolean`	:vartype disable_local_auth: bool
`dynamicThrottlingEnabled`	`boolean`	The flag to enable dynamic throttling.
`encryption`	`object`	The encryption properties for this resource.
`endpoint`	`string`	Endpoint of the created account.
`endpoints`	`object`	Dictionary of .
`etag`	`string`	Resource Etag.
`foundryAutoUpgrade`	`object`	Represents the foundry auto-upgrade configuration for a Cognitive Services account.
`identity`	`object`	Identity for the resource.
`internalId`	`string`	The internal identifier (deprecated, do not use this property).
`isMigrated`	`boolean`	If the resource is migrated from an existing key.
`kind`	`string`	The kind (type) of cognitive service account.
`location`	`string`	The geo-location where the resource lives.
`locations`	`object`	The multiregion settings of Cognitive Services account.
`migrationToken`	`string`	Resource migration token.
`networkAcls`	`object`	A collection of rules governing the accessibility from specific network locations.
`networkInjections`	`array`	:vartype network_injections: list[~azure.mgmt.cognitiveservices.models.NetworkInjection]
`privateEndpointConnections`	`array`	The private endpoint connection associated with the Cognitive Services account.
`provisioningState`	`string`	Gets the status of the cognitive services account at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", "Canceled", and "ResolvingDNS". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled, ResolvingDNS)
`publicNetworkAccess`	`string`	Whether or not public endpoint access is allowed for this account. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`quotaLimit`	`object`	:vartype quota_limit: ~azure.mgmt.cognitiveservices.models.QuotaLimit
`raiMonitorConfig`	`object`	Cognitive Services Rai Monitor Config.
`restore`	`boolean`	:vartype restore: bool
`restrictOutboundNetworkAccess`	`boolean`	:vartype restrict_outbound_network_access: bool
`scheduledPurgeDate`	`string`	The scheduled purge date, only available for deleted account.
`sku`	`object`	The resource model definition representing SKU.
`skuChangeInfo`	`object`	Sku change info of account.
`storedCompletionsDisabled`	`boolean`	The flag to disable stored completions.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`userOwnedStorage`	`array`	The storage accounts for this resource.

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.
`abusePenalty`	`object`	The abuse penalty.
`allowProjectManagement`	`boolean`	Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry.
`allowedFqdnList`	`array`	:vartype allowed_fqdn_list: list[str]
`amlWorkspace`	`object`	The user owned AML account properties.
`apiProperties`	`object`	The api properties for special APIs.
`associatedProjects`	`array`	Specifies the projects, by project name, that are associated with this resource.
`callRateLimit`	`object`	The call rate limit Cognitive Services account.
`capabilities`	`array`	Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.
`commitmentPlanAssociations`	`array`	The commitment plan associations of Cognitive Services account.
`customSubDomainName`	`string`	Optional subdomain name used for token-based authentication.
`dateCreated`	`string`	Gets the date of cognitive services account creation.
`defaultProject`	`string`	Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter.
`deletionDate`	`string`	The deletion date, only available for deleted account.
`disableLocalAuth`	`boolean`	:vartype disable_local_auth: bool
`dynamicThrottlingEnabled`	`boolean`	The flag to enable dynamic throttling.
`encryption`	`object`	The encryption properties for this resource.
`endpoint`	`string`	Endpoint of the created account.
`endpoints`	`object`	Dictionary of .
`etag`	`string`	Resource Etag.
`foundryAutoUpgrade`	`object`	Represents the foundry auto-upgrade configuration for a Cognitive Services account.
`identity`	`object`	Identity for the resource.
`internalId`	`string`	The internal identifier (deprecated, do not use this property).
`isMigrated`	`boolean`	If the resource is migrated from an existing key.
`kind`	`string`	The kind (type) of cognitive service account.
`location`	`string`	The geo-location where the resource lives.
`locations`	`object`	The multiregion settings of Cognitive Services account.
`migrationToken`	`string`	Resource migration token.
`networkAcls`	`object`	A collection of rules governing the accessibility from specific network locations.
`networkInjections`	`array`	:vartype network_injections: list[~azure.mgmt.cognitiveservices.models.NetworkInjection]
`privateEndpointConnections`	`array`	The private endpoint connection associated with the Cognitive Services account.
`provisioningState`	`string`	Gets the status of the cognitive services account at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", "Canceled", and "ResolvingDNS". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled, ResolvingDNS)
`publicNetworkAccess`	`string`	Whether or not public endpoint access is allowed for this account. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`quotaLimit`	`object`	:vartype quota_limit: ~azure.mgmt.cognitiveservices.models.QuotaLimit
`raiMonitorConfig`	`object`	Cognitive Services Rai Monitor Config.
`restore`	`boolean`	:vartype restore: bool
`restrictOutboundNetworkAccess`	`boolean`	:vartype restrict_outbound_network_access: bool
`scheduledPurgeDate`	`string`	The scheduled purge date, only available for deleted account.
`sku`	`object`	The resource model definition representing SKU.
`skuChangeInfo`	`object`	Sku change info of account.
`storedCompletionsDisabled`	`boolean`	The flag to disable stored completions.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`userOwnedStorage`	`array`	The storage accounts for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get`	`select`	`location`, `resource_group_name`, `account_name`, `subscription_id`	Returns a Cognitive Services account specified by the parameters.
`list`	`select`	`subscription_id`	Returns all the resources of a particular type belonging to a subscription.
`purge`	`delete`	`location`, `resource_group_name`, `account_name`, `subscription_id`	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
`account_name`	`string`	The name of Cognitive Services account. Required.
`location`	`string`	The location name. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`subscription_id`	`string`

`SELECT` examples

get
list

Returns a Cognitive Services account specified by the parameters.

SELECT
id,
name,
abusePenalty,
allowProjectManagement,
allowedFqdnList,
amlWorkspace,
apiProperties,
associatedProjects,
callRateLimit,
capabilities,
commitmentPlanAssociations,
customSubDomainName,
dateCreated,
defaultProject,
deletionDate,
disableLocalAuth,
dynamicThrottlingEnabled,
encryption,
endpoint,
endpoints,
etag,
foundryAutoUpgrade,
identity,
internalId,
isMigrated,
kind,
location,
locations,
migrationToken,
networkAcls,
networkInjections,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
quotaLimit,
raiMonitorConfig,
restore,
restrictOutboundNetworkAccess,
scheduledPurgeDate,
sku,
skuChangeInfo,
storedCompletionsDisabled,
systemData,
tags,
type,
userOwnedStorage
FROM azure.cognitive_services.deleted_accounts
WHERE location = '{{ location }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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

SELECT
id,
name,
abusePenalty,
allowProjectManagement,
allowedFqdnList,
amlWorkspace,
apiProperties,
associatedProjects,
callRateLimit,
capabilities,
commitmentPlanAssociations,
customSubDomainName,
dateCreated,
defaultProject,
deletionDate,
disableLocalAuth,
dynamicThrottlingEnabled,
encryption,
endpoint,
endpoints,
etag,
foundryAutoUpgrade,
identity,
internalId,
isMigrated,
kind,
location,
locations,
migrationToken,
networkAcls,
networkInjections,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
quotaLimit,
raiMonitorConfig,
restore,
restrictOutboundNetworkAccess,
scheduledPurgeDate,
sku,
skuChangeInfo,
storedCompletionsDisabled,
systemData,
tags,
type,
userOwnedStorage
FROM azure.cognitive_services.deleted_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

`DELETE` examples

purge

Deletes a Cognitive Services account from the resource group.

DELETE FROM azure.cognitive_services.deleted_accounts
WHERE location = '{{ location }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

DELETE examples​