organizations

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

Overview

Name	organizations
Type	Resource
Id	azure_isv.confluent.organizations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ARM id of the resource.
name	string	The name of the resource.
location	string	Location of Organization resource
properties	object	Organization resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Organization resource tags
type	string	The type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	The ARM id of the resource.
name	string	The name of the resource.
location	string	Location of Organization resource
properties	object	Organization resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Organization resource tags
type	string	The type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	The ARM id of the resource.
name	string	The name of the resource.
location	string	Location of Organization resource
properties	object	Organization resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Organization resource tags
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, organizationName
list_by_resource_group	select	subscriptionId, resourceGroupName
list_by_subscription	select	subscriptionId
create	insert	subscriptionId, resourceGroupName, organizationName, data__properties
update	update	subscriptionId, resourceGroupName, organizationName
delete	delete	subscriptionId, resourceGroupName, organizationName

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
organizationName	string	Organization resource name
resourceGroupName	string	Resource group name
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Success

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_isv.confluent.organizations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND organizationName = '{{ organizationName }}' -- required
;

list_by_resource_group

Success

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_isv.confluent.organizations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Success

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_isv.confluent.organizations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure_isv.confluent.organizations (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
organizationName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ organizationName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: organizations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the organizations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the organizations resource.
    - name: organizationName
      value: string
      description: Required parameter for the organizations resource.
    - name: properties
      value: object
      description: |
        Organization resource properties
    - name: tags
      value: object
      description: |
        Organization resource tags
    - name: location
      value: string
      description: |
        Location of Organization resource

UPDATE examples

update

No description available.

UPDATE azure_isv.confluent.organizations
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND organizationName = '{{ organizationName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

No description available.

DELETE FROM azure_isv.confluent.organizations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND organizationName = '{{ organizationName }}' --required
;