Share via

az datadog sso-config

  • Reference

Note

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

Manage sso config with datadog.

Commands

Name Description Type Status
az datadog sso-config create

Configures single-sign-on for this resource.

 Extension GA
az datadog sso-config list

List the single sign-on configurations for a given monitor resource.

 Extension GA
az datadog sso-config show

Gets the datadog single sign-on resource for the given Monitor.

 Extension GA
az datadog sso-config update

Configures single-sign-on for this resource.

 Extension GA
az datadog sso-config wait

Place the CLI in a waiting state until a condition of the datadog sso-config is met.

 Extension GA

az datadog sso-config create

Configures single-sign-on for this resource.

az datadog sso-config create --configuration-name
                             --monitor-name
                             --resource-group
                             [--no-wait]
                             [--properties]

Examples

SingleSignOnConfigurations_CreateOrUpdate

az datadog sso-config create --configuration-name "default" --monitor-name "myMonitor" --properties enterprise-app-id="00000000-0000-0000-0000-000000000000" single-sign-on-state="Enable" --resource-group "myResourceGroup"

Required Parameters

--configuration-name

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

--no-wait

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

Default value: False
--properties

Usage: --properties single-sign-on-state=XX enterprise-app-id=XX

single-sign-on-state: Various states of the SSO resource enterprise-app-id: The Id of the Enterprise App used for Single sign-on.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datadog sso-config list

List the single sign-on configurations for a given monitor resource.

az datadog sso-config list --monitor-name
                           --resource-group

Examples

SingleSignOnConfigurations_List

az datadog sso-config list --monitor-name "myMonitor" --resource-group "myResourceGroup"

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>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datadog sso-config show

Gets the datadog single sign-on resource for the given Monitor.

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

Examples

SingleSignOnConfigurations_Get

az datadog sso-config show --configuration-name "default" --monitor-name "myMonitor" --resource-group "myResourceGroup"

Optional Parameters

--configuration-name

Configuration name.

--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.

--monitor-name

Monitor resource name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datadog sso-config update

Configures single-sign-on for this resource.

az datadog sso-config update [--add]
                             [--configuration-name]
                             [--force-string]
                             [--ids]
                             [--monitor-name]
                             [--no-wait]
                             [--properties]
                             [--remove]
                             [--resource-group]
                             [--set]
                             [--subscription]

Optional Parameters

--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>.

Default value: []
--configuration-name

Configuration name.

--force-string

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

Default value: False
--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.

--monitor-name

Monitor resource name.

--no-wait

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

Default value: False
--properties

Usage: --properties single-sign-on-state=XX enterprise-app-id=XX

single-sign-on-state: Various states of the SSO resource enterprise-app-id: The Id of the Enterprise App used for Single sign-on.

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az datadog sso-config wait

Place the CLI in a waiting state until a condition of the datadog sso-config is met.

az datadog sso-config wait [--configuration-name]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--monitor-name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Examples

Pause executing next line of CLI script until the datadog sso-config is successfully created.

az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" --resource-group "myResourceGroup" --created

Pause executing next line of CLI script until the datadog sso-config is successfully updated.

az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" --resource-group "myResourceGroup" --updated

Optional Parameters

--configuration-name

Configuration name.

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--monitor-name

Monitor resource name.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.