Default Azure Authentication Method

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

The Default Azure Authentication Method may be used to authenticate to the Azure service from within services running in the Azure Cloud.

Parent Component Properties dsconfig Usage

Parent Component

The Default Azure Authentication Method component inherits from the Azure Authentication Method

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 tenant-id
 client-id

Basic Properties

description

Description
A description for this Azure Authentication Method
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

tenant-id

Description
The tenant ID to use to authenticate. If this is not provided, then it will be obtained from the AZURE_TENANT_ID environment variable.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

client-id

Description
The client ID to use to authenticate. If this is not provided, then it will be obtained from the AZURE_CLIENT_ID
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Azure Authentication Methods:

dsconfig list-azure-authentication-methods
     [--property {propertyName}] ...

To view the configuration for an existing Azure Authentication Method:

dsconfig get-azure-authentication-method-prop
     --method-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Azure Authentication Method:

dsconfig set-azure-authentication-method-prop
     --method-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Default Azure Authentication Method:

dsconfig create-azure-authentication-method
     --method-name {name}
     --type default
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Azure Authentication Method:

dsconfig delete-azure-authentication-method
     --method-name {name}