projects

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

Overview

Name	projects
Type	Resource
Id	azure.cognitive_services.projects

Fields

The following fields are returned by SELECT queries:

get

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.
description	string	The description of the Cognitive Services Project.
displayName	string	The display name of the Cognitive Services Project.
endpoints	object	The list of endpoint for this Cognitive Services Project.
etag	string	Resource Etag.
identity	object	Identity for the resource.
isDefault	boolean	Indicates whether the project is the default project for the account.
location	string	The geo-location where the resource lives.
provisioningState	string	Gets the status of the cognitive services project 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)
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".

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.
description	string	The description of the Cognitive Services Project.
displayName	string	The display name of the Cognitive Services Project.
endpoints	object	The list of endpoint for this Cognitive Services Project.
etag	string	Resource Etag.
identity	object	Identity for the resource.
isDefault	boolean	Indicates whether the project is the default project for the account.
location	string	The geo-location where the resource lives.
provisioningState	string	Gets the status of the cognitive services project 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)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, project_name, subscription_id		Returns a Cognitive Services project specified by the parameters.
list	select	resource_group_name, account_name, subscription_id		Returns all the projects in a Cognitive Services account.
create	insert	resource_group_name, account_name, project_name, subscription_id		Create Cognitive Services Account's Project. Project is a sub-resource of an account which give AI developer it's individual container to work on.
update	update	resource_group_name, account_name, project_name, subscription_id		Updates a Cognitive Services Project.
delete	delete	resource_group_name, account_name, project_name, subscription_id		Deletes a Cognitive Services project 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.
project_name	string	The name of Cognitive Services account's project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns a Cognitive Services project specified by the parameters.

SELECT
id,
name,
description,
displayName,
endpoints,
etag,
identity,
isDefault,
location,
provisioningState,
systemData,
tags,
type
FROM azure.cognitive_services.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns all the projects in a Cognitive Services account.

SELECT
id,
name,
description,
displayName,
endpoints,
etag,
identity,
isDefault,
location,
provisioningState,
systemData,
tags,
type
FROM azure.cognitive_services.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Cognitive Services Account's Project. Project is a sub-resource of an account which give AI developer it's individual container to work on.

INSERT INTO azure.cognitive_services.projects (
properties,
tags,
location,
identity,
resource_group_name,
account_name,
project_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the projects resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the projects resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the projects resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the projects resource.
  - name: properties
    description: |
      Properties of Cognitive Services project.
    value:
      provisioningState: "{{ provisioningState }}"
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      endpoints: "{{ endpoints }}"
      isDefault: {{ isDefault }}
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: identity
    description: |
      Identity for the resource.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a Cognitive Services Project.

UPDATE azure.cognitive_services.projects
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Cognitive Services project from the resource group.

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