organizations

Creates, updates, deletes, gets or lists an organizations resource.

Overview

Name	organizations
Type	Resource
Id	azure_isv.mongodbatlas.organizations

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
partnerProperties	object	MongoDB properties.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	Details of the user. Required.

list_by_resource_group

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
partnerProperties	object	MongoDB properties.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	Details of the user. Required.

list_by_subscription

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
partnerProperties	object	MongoDB properties.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	Details of the user. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, organization_name, subscription_id		Get a OrganizationResource.
list_by_resource_group	select	resource_group_name, subscription_id		List OrganizationResource resources by resource group.
list_by_subscription	select	subscription_id		List OrganizationResource resources by subscription ID.
create_or_update	insert	resource_group_name, organization_name, subscription_id, location		Create a OrganizationResource.
update	update	resource_group_name, organization_name, subscription_id		Update a OrganizationResource.
create_or_update	replace	resource_group_name, organization_name, subscription_id, location		Create a OrganizationResource.
delete	delete	resource_group_name, organization_name, subscription_id		Delete a OrganizationResource.

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

SELECT examples

get

Get a OrganizationResource.

SELECT
id,
name,
identity,
location,
marketplace,
partnerProperties,
provisioningState,
systemData,
tags,
type,
user
FROM azure_isv.mongodbatlas.organizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List OrganizationResource resources by resource group.

SELECT
id,
name,
identity,
location,
marketplace,
partnerProperties,
provisioningState,
systemData,
tags,
type,
user
FROM azure_isv.mongodbatlas.organizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List OrganizationResource resources by subscription ID.

SELECT
id,
name,
identity,
location,
marketplace,
partnerProperties,
provisioningState,
systemData,
tags,
type,
user
FROM azure_isv.mongodbatlas.organizations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a OrganizationResource.

INSERT INTO azure_isv.mongodbatlas.organizations (
tags,
location,
properties,
identity,
resource_group_name,
organization_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: organizations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the organizations resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the organizations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the organizations 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:
      marketplace:
        subscriptionId: "{{ subscriptionId }}"
        subscriptionStatus: "{{ subscriptionStatus }}"
        offerDetails:
          publisherId: "{{ publisherId }}"
          offerId: "{{ offerId }}"
          planId: "{{ planId }}"
          planName: "{{ planName }}"
          termUnit: "{{ termUnit }}"
          termId: "{{ termId }}"
      user:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        upn: "{{ upn }}"
        phoneNumber: "{{ phoneNumber }}"
        companyName: "{{ companyName }}"
      provisioningState: "{{ provisioningState }}"
      partnerProperties:
        organizationId: "{{ organizationId }}"
        redirectUrl: "{{ redirectUrl }}"
        organizationName: "{{ organizationName }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a OrganizationResource.

UPDATE azure_isv.mongodbatlas.organizations
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a OrganizationResource.

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

DELETE examples

delete

Delete a OrganizationResource.

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