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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
enforcePrivateMarkdownStorage	boolean	When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
enforcePrivateMarkdownStorage	boolean	When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "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	configuration_name		Gets the tenant configuration.
list	select			Gets list of the tenant configurations.
create	insert	configuration_name		Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.
delete	delete	configuration_name		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
configuration_name	string	The name of the Configuration. Required.

SELECT examples

get

Gets the tenant configuration.

SELECT
id,
name,
enforcePrivateMarkdownStorage,
provisioningState,
systemData,
type
FROM azure.portal.tenant_configurations
WHERE configuration_name = '{{ configuration_name }}' -- required
;

list

Gets list of the tenant configurations.

SELECT
id,
name,
enforcePrivateMarkdownStorage,
provisioningState,
systemData,
type
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 (
properties,
configuration_name
)
SELECT 
'{{ properties }}',
'{{ configuration_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: tenant_configurations
props:
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the tenant_configurations resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      enforcePrivateMarkdownStorage: {{ enforcePrivateMarkdownStorage }}
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

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

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