tenant_configurations

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

Overview

Name	tenant_configurations
Type	Resource
Id	azure.portal.tenant_configurations

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	configurationName		Gets the tenant configuration.
list	select			Gets list of the tenant configurations.
create	insert	configurationName		Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.
delete	delete	configurationName		Delete the tenant configuration. User has to be a Tenant Admin for this operation.

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
configurationName	string	The name of the Configuration

SELECT examples

get

Gets the tenant configuration.

SELECT
properties
FROM azure.portal.tenant_configurations
WHERE configurationName = '{{ configurationName }}' -- required
;

list

Gets list of the tenant configurations.

SELECT
properties
FROM azure.portal.tenant_configurations
;

INSERT examples

create

Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.

INSERT INTO azure.portal.tenant_configurations (
data__properties,
configurationName
)
SELECT 
'{{ properties }}',
'{{ configurationName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: tenant_configurations
  props:
    - name: configurationName
      value: string
      description: Required parameter for the tenant_configurations resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete the tenant configuration. User has to be a Tenant Admin for this operation.

DELETE FROM azure.portal.tenant_configurations
WHERE configurationName = '{{ configurationName }}' --required
;