projects

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

Overview

Name	projects
Type	Resource
Id	azure_isv.mongodbatlas.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.
clusterCount	integer	Number of clusters in the project.
organizationId	string	Atlas organization id.
projectId	string	Atlas project id.
projectName	string	Atlas project name.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
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

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.
clusterCount	integer	Number of clusters in the project.
organizationId	string	Atlas organization id.
projectId	string	Atlas project id.
projectName	string	Atlas project name.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
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	select	resource_group_name, organization_name, project_name, subscription_id		Get a Project.
list	select	resource_group_name, organization_name, subscription_id		List Project resources by OrganizationResource.
create_or_update	insert	resource_group_name, organization_name, project_name, subscription_id		Create a Project.
create_or_update	replace	resource_group_name, organization_name, project_name, subscription_id		Create a Project.
delete	delete	resource_group_name, organization_name, project_name, subscription_id		Delete a Project.
list_cluster_tier_regions	exec	resource_group_name, organization_name, project_name, subscription_id		List available regions by cluster tier for the project.
tier_limit_reached	exec	resource_group_name, organization_name, project_name, subscription_id		Check if tier limit is reached for the 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
organization_name	string	Name of the Organization resource. Required.
project_name	string	Name of the MongoDB Atlas Project resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Project.

SELECT
id,
name,
clusterCount,
organizationId,
projectId,
projectName,
provisioningState,
systemData,
type
FROM azure_isv.mongodbatlas.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Project resources by OrganizationResource.

SELECT
id,
name,
clusterCount,
organizationId,
projectId,
projectName,
provisioningState,
systemData,
type
FROM azure_isv.mongodbatlas.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Project.

INSERT INTO azure_isv.mongodbatlas.projects (
properties,
resource_group_name,
organization_name,
project_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
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: organization_name
    value: "{{ organization_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: |
      The resource-specific properties for this resource.
    value:
      projectId: "{{ projectId }}"
      projectName: "{{ projectName }}"
      organizationId: "{{ organizationId }}"
      clusterCount: {{ clusterCount }}
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a Project.

REPLACE azure_isv.mongodbatlas.projects
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Project.

DELETE FROM azure_isv.mongodbatlas.projects
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_cluster_tier_regions

List available regions by cluster tier for the project.

EXEC azure_isv.mongodbatlas.projects.list_cluster_tier_regions 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

tier_limit_reached

Check if tier limit is reached for the project.

EXEC azure_isv.mongodbatlas.projects.tier_limit_reached 
@resource_group_name='{{ resource_group_name }}' --required, 
@organization_name='{{ organization_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;