az aldo system-configuration

Note

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

Manage ALDO system configuration.

Commands

Name Description Type Status
az aldo system-configuration create

Create or fully replace the active ALDO system configuration.

Extension GA
az aldo system-configuration show

Show the active ALDO system configuration.

Extension GA

az aldo system-configuration create

Create or fully replace the active ALDO system configuration.

Sends a PUT request for the default singleton. This replaces the configuration rather than merging changes; omitted writable fields are not preserved. The service requires --dns-forwarder-ip, --connection-intent, --stamp-id, and --device-resource-id on every PUT. The current subscription must be the Operator subscription.

az aldo system-configuration create [--acquire-policy-token]
                                    [--change-reference]
                                    [--connection-intent]
                                    [--device-resource-id]
                                    [--dns-forwarder-ip]
                                    [--stamp-id]

Examples

Replace the system configuration with all four required writable values.

az aldo system-configuration create --dns-forwarder-ip 192.0.2.53 --connection-intent Connected --stamp-id 11111111-1111-1111-1111-111111111111 --device-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-aldo/providers/Microsoft.Edge/disconnectedOperations/example-device

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
--connection-intent

Connection intent for the system, such as Connected or Disconnected.

--device-resource-id

Resource ID of the Microsoft.Edge/disconnectedOperations device.

--dns-forwarder-ip

IP address of the DNS forwarder used by the system.

--stamp-id

GUID of the stamp hosting the system.

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 aldo system-configuration show

Show the active ALDO system configuration.

Retrieves the system configuration singleton. The current subscription must be the Operator subscription.

az aldo system-configuration show

Examples

Show the active system configuration.

az aldo system-configuration show
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