az aro identity

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage identities related to Azure Red Hat OpenShift clusters.

Commands

Name Description Type Status
az aro identity create-required

Create required identities.

 Core GA
az aro identity create-required (aro extension)

Create required identities.

 Extension Preview
az aro identity get-required

Get required identities.

 Core GA
az aro identity get-required (aro extension)

Get required identities.

 Extension Preview

az aro identity create-required

Edit

Create required identities.

Create required identities to prepare for creating a cluster with managed identities.

az aro identity create-required --location
                                --master-subnet
                                --resource-group
                                --version
                                --worker-subnet
                                [--acquire-policy-token]
                                [--change-reference]
                                [--disk-encryption-set]
                                [--vnet]
                                [--vnet-resource-group]
                                [--yes]

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--resource-group -g

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

--version

OpenShift version to use for cluster creation.

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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
--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

--yes -y

Do not prompt for confirmation.

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

--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 aro identity create-required (aro extension)

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create required identities.

Create required identities to prepare for creating a Standard cluster with managed identities.

az aro identity create-required --location
                                --master-subnet
                                --resource-group
                                --version
                                --worker-subnet
                                [--acquire-policy-token]
                                [--change-reference]
                                [--disk-encryption-set]
                                [--vnet]
                                [--vnet-resource-group]
                                [--yes]

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--resource-group -g

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

--version

OpenShift version to use for cluster creation.

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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
--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

--yes -y

Do not prompt for confirmation.

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

--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 aro identity get-required

Edit

Get required identities.

Get required identities for creating a cluster with managed identities.

az aro identity get-required --location
                             --master-subnet
                             --resource-group
                             --version
                             --worker-subnet
                             [--acquire-policy-token]
                             [--change-reference]
                             [--disk-encryption-set]
                             [--vnet]
                             [--vnet-resource-group]

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--resource-group -g

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

--version

OpenShift version to use for cluster creation.

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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
--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

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 aro identity get-required (aro extension)

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get required identities.

Get required identities for creating a Standard cluster with managed identities.

az aro identity get-required --location
                             --master-subnet
                             --resource-group
                             --version
                             --worker-subnet
                             [--acquire-policy-token]
                             [--change-reference]
                             [--disk-encryption-set]
                             [--vnet]
                             [--vnet-resource-group]

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--resource-group -g

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

--version

OpenShift version to use for cluster creation.

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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
--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

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