projects

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

Overview

Name	projects
Type	Resource
Id	azure.discovery.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.
foundryProjectEndpoint	string	Foundry project endpoint URI.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
settings	object	Settings for the project.
storageContainerIds	array	Allowed StorageContainers (Control plane resource references).
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_by_workspace

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.
foundryProjectEndpoint	string	Foundry project endpoint URI.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
settings	object	Settings for the project.
storageContainerIds	array	Allowed StorageContainers (Control plane resource references).
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, workspace_name, project_name, subscription_id		Get a Project.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List Project resources by Workspace.
create_or_update	insert	resource_group_name, workspace_name, project_name, subscription_id, location		Create a Project.
update	update	resource_group_name, workspace_name, project_name, subscription_id, location		Update a Project.
create_or_update	replace	resource_group_name, workspace_name, project_name, subscription_id, location		Create a Project.
delete	delete	resource_group_name, workspace_name, project_name, subscription_id		Delete a Project.

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
project_name	string	The name of the Project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the Workspace. Required.

SELECT examples

get

Get a Project.

SELECT
id,
name,
foundryProjectEndpoint,
location,
provisioningState,
settings,
storageContainerIds,
systemData,
tags,
type
FROM azure.discovery.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

List Project resources by Workspace.

SELECT
id,
name,
foundryProjectEndpoint,
location,
provisioningState,
settings,
storageContainerIds,
systemData,
tags,
type
FROM azure.discovery.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Project.

INSERT INTO azure.discovery.projects (
tags,
location,
properties,
resource_group_name,
workspace_name,
project_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
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: workspace_name
    value: "{{ workspace_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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      foundryProjectEndpoint: "{{ foundryProjectEndpoint }}"
      storageContainerIds:
        - "{{ storageContainerIds }}"
      settings:
        behaviorPreferences: "{{ behaviorPreferences }}"

UPDATE examples

update

Update a Project.

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

REPLACE examples

create_or_update

Create a Project.

REPLACE azure.discovery.projects
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Project.

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