az dynatrace monitor sso-config

Note

This reference is part of the dynatrace extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az dynatrace monitor sso-config command. Learn more about extensions.

Manage Single Sign-On (SSO) configuration between Azure and Dynatrace. This enables unified authentication for users accessing Dynatrace through Azure.

Commands

Name	Description	Type	Status
az dynatrace monitor sso-config create	Create a new SSO configuration for seamless authentication between Azure and the Dynatrace platform.	Extension	GA
az dynatrace monitor sso-config list	List all SSO configurations associated with a specific Dynatrace resource.	Extension	GA
az dynatrace monitor sso-config show	Get information about a specific Dynatrace SSO configuration including SSO state and URL.	Extension	GA
az dynatrace monitor sso-config update	Update a DynatraceSingleSignOnResource.	Extension	GA
az dynatrace monitor sso-config wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az dynatrace monitor sso-config create

Create a new SSO configuration for seamless authentication between Azure and the Dynatrace platform.

az dynatrace monitor sso-config create --configuration-name --name
                                       --monitor-name
                                       --resource-group
                                       [--aad-domains]
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--enterprise-app-id]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--single-sign-on-state {Disable, Enable, Existing, Initial}]
                                       [--single-sign-on-url]

Examples

Create a sso-config

az dynatrace monitor sso-config create -g rg --monitor-name monitor -n default --aad-domains "['mpliftrdt20210811outlook.onmicrosoft.com']" --single-sign-on-url "https://www.dynatrace.io"

Required Parameters

--configuration-name --name -n

Single Sign On Configuration Name.

--monitor-name

Monitor resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad-domains

Array of Aad(azure active directory) domains Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--enterprise-app-id

Version of the Dynatrace agent installed on the VM.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--single-sign-on-state

State of Single Sign On.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disable, Enable, Existing, Initial

--single-sign-on-url

The login URL specific to this Dynatrace Environment.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dynatrace monitor sso-config list

List all SSO configurations associated with a specific Dynatrace resource.

az dynatrace monitor sso-config list --monitor-name
                                     --resource-group
                                     [--max-items]
                                     [--next-token]

Examples

List sso-config

az dynatrace monitor sso-config list -g rg --monitor-name monitor

Required Parameters

--monitor-name

Monitor resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dynatrace monitor sso-config show

Get information about a specific Dynatrace SSO configuration including SSO state and URL.

az dynatrace monitor sso-config show [--configuration-name --name]
                                     [--ids]
                                     [--monitor-name]
                                     [--resource-group]
                                     [--subscription]

Examples

Show sso-config

az dynatrace monitor sso-config show -g rg --monitor-name monitor -n default

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--configuration-name --name -n

Single Sign On Configuration Name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dynatrace monitor sso-config update

Update a DynatraceSingleSignOnResource.

az dynatrace monitor sso-config update [--aad-domains]
                                       [--acquire-policy-token]
                                       [--add]
                                       [--change-reference]
                                       [--configuration-name --name]
                                       [--enterprise-app-id]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--monitor-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--single-sign-on-state {Disable, Enable, Existing, Initial}]
                                       [--single-sign-on-url]
                                       [--subscription]

Examples

SingleSignOn_CreateOrUpdate_MaximumSet_Gen

az dynatrace monitor sso-config update --resource-group {rg} --monitor-name {monitor} -n default --aad-domains [\'mpliftrdt20210811outlook.onmicrosoft.com\'] --single-sign-on-url "https://www.dynatrace.io"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad-domains

Array of Aad(azure active directory) domains Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--configuration-name --name -n

Single Sign On Configuration Name.

Property	Value
Parameter group:	Resource Id Arguments

--enterprise-app-id

Version of the Dynatrace agent installed on the VM.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--single-sign-on-state

State of Single Sign On.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disable, Enable, Existing, Initial

--single-sign-on-url

The login URL specific to this Dynatrace Environment.

Property	Value
Parameter group:	Properties Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dynatrace monitor sso-config wait

Place the CLI in a waiting state until a condition is met.

az dynatrace monitor sso-config wait [--acquire-policy-token]
                                     [--change-reference]
                                     [--configuration-name --name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--monitor-name]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--configuration-name --name -n

Single Sign On Configuration Name.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az dynatrace monitor sso-config

Commands

az dynatrace monitor sso-config create

Examples

Required Parameters

Optional Parameters

az dynatrace monitor sso-config list

Examples

Required Parameters

Optional Parameters

az dynatrace monitor sso-config show

Examples

Optional Parameters

az dynatrace monitor sso-config update

Examples

Optional Parameters

az dynatrace monitor sso-config wait

Optional Parameters

Feedback