single_sign_on

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

Overview

Name	single_sign_on
Type	Resource
Id	azure_isv.dynatrace.single_sign_on

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.
aadDomains	array	array of Aad(azure active directory) domains.
enterpriseAppId	string	Version of the Dynatrace agent installed on the VM.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
singleSignOnState	string	State of Single Sign On. Known values are: "Initial", "Enable", "Disable", and "Existing".
singleSignOnUrl	string	The login URL specific to this Dynatrace Environment.
systemData	object	System metadata for this resource.
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.
aadDomains	array	array of Aad(azure active directory) domains.
enterpriseAppId	string	Version of the Dynatrace agent installed on the VM.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
singleSignOnState	string	State of Single Sign On. Known values are: "Initial", "Enable", "Disable", and "Existing".
singleSignOnUrl	string	The login URL specific to this Dynatrace Environment.
systemData	object	System metadata for this resource.
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, monitor_name, configuration_name, subscription_id		Get a DynatraceSingleSignOnResource. Get a DynatraceSingleSignOnResource.
list	select	resource_group_name, monitor_name, subscription_id		List all DynatraceSingleSignOnResource by monitorName. List all DynatraceSingleSignOnResource by monitorName.
create_or_update	insert	resource_group_name, monitor_name, configuration_name, subscription_id		Create a DynatraceSingleSignOnResource. Create a DynatraceSingleSignOnResource.
create_or_update	replace	resource_group_name, monitor_name, configuration_name, subscription_id		Create a DynatraceSingleSignOnResource. Create a DynatraceSingleSignOnResource.

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	Single Sign On Configuration Name. Required.
monitor_name	string	Monitor resource name. 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 DynatraceSingleSignOnResource. Get a DynatraceSingleSignOnResource.

SELECT
id,
name,
aadDomains,
enterpriseAppId,
provisioningState,
singleSignOnState,
singleSignOnUrl,
systemData,
type
FROM azure_isv.dynatrace.single_sign_on
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all DynatraceSingleSignOnResource by monitorName. List all DynatraceSingleSignOnResource by monitorName.

SELECT
id,
name,
aadDomains,
enterpriseAppId,
provisioningState,
singleSignOnState,
singleSignOnUrl,
systemData,
type
FROM azure_isv.dynatrace.single_sign_on
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DynatraceSingleSignOnResource. Create a DynatraceSingleSignOnResource.

INSERT INTO azure_isv.dynatrace.single_sign_on (
properties,
resource_group_name,
monitor_name,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: single_sign_on
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the single_sign_on resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the single_sign_on resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the single_sign_on resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the single_sign_on resource.
  - name: properties
    value:
      singleSignOnState: "{{ singleSignOnState }}"
      enterpriseAppId: "{{ enterpriseAppId }}"
      singleSignOnUrl: "{{ singleSignOnUrl }}"
      aadDomains:
        - "{{ aadDomains }}"

REPLACE examples

create_or_update

Create a DynatraceSingleSignOnResource. Create a DynatraceSingleSignOnResource.

REPLACE azure_isv.dynatrace.single_sign_on
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;