Share via


az edgeorder

Note

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

Manage Edge Order.

Commands

Name Description Type Status
az edgeorder address

Manage address with edgeorder sub group address.

Extension GA
az edgeorder address create

Create a new address with the specified parameters. Existing address can be updated with this API.

Extension GA
az edgeorder address delete

Delete an address.

Extension GA
az edgeorder address list

List all the addresses available under the given resource group. And List all the addresses available under the subscription.

Extension GA
az edgeorder address show

Get information about the specified address.

Extension GA
az edgeorder address update

Update the properties of an existing address.

Extension GA
az edgeorder address wait

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

Extension GA
az edgeorder list-config

This method provides the list of configurations for the given product family, product line and product under subscription.

Extension GA
az edgeorder list-family

This method provides the list of product families for the given subscription.

Extension GA
az edgeorder list-metadata

This method provides the list of product families metadata for the given subscription.

Extension GA
az edgeorder order

Manage order with edgeorder sub group order.

Extension GA
az edgeorder order-item

Manage order item with edgeorder sub group order-item.

Extension GA
az edgeorder order-item cancel

Cancel order item.

Extension GA
az edgeorder order-item create

Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.

Extension GA
az edgeorder order-item delete

Delete an order item.

Extension GA
az edgeorder order-item list

List order item at resource group level. And List order item at subscription level.

Extension GA
az edgeorder order-item return

Return order item.

Extension GA
az edgeorder order-item show

Get an order item.

Extension GA
az edgeorder order-item update

Update the properties of an existing order item.

Extension GA
az edgeorder order-item wait

Place the CLI in a waiting state until a condition of the order-item is met.

Extension GA
az edgeorder order list

List order at resource group level. And List order at subscription level.

Extension GA
az edgeorder order show

Get an order.

Extension GA

az edgeorder list-config

This method provides the list of configurations for the given product family, product line and product under subscription.

az edgeorder list-config --configuration-filters
                         [--location-placement-id]
                         [--quota-id]
                         [--registered-features]
                         [--skip-token]

Examples

ListConfigurations

az edgeorder list-config --configuration-filters "[{\"filterableProperty\":[{\"type\":\"ShipToCountries\",\"supportedValues\":[\"US\"]}],\"hierarchyInformation\":{\"productFamilyName\":\"AzureStackEdge\",\"productLineName\":\"AzureStackEdge\",\"productName\":\"AzureStackEdgeGPU\"}}]"

Required Parameters

--configuration-filters

Holds details about product hierarchy information and filterable property. Expected value: json-string/json-file/@json-file.

Optional Parameters

--location-placement-id

Location placement Id of a subscription.

--quota-id

Quota ID of a subscription.

--registered-features

List of registered feature flags for subscription.

Usage: --registered-features name=XX state=XX

name: Name of subscription registered feature state: State of subscription registered feature

Multiple actions can be specified by using more than one --registered-features argument.

--skip-token

$skipToken is supported on list of configurations, which provides the next page in the list of configurations.

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 edgeorder list-family

This method provides the list of product families for the given subscription.

az edgeorder list-family --filterable-properties
                         [--expand]
                         [--location-placement-id]
                         [--quota-id]
                         [--registered-features]
                         [--skip-token]

Examples

ListProductFamilies

az edgeorder list-family --filterable-properties azurestackedge="{\"type\":\"ShipToCountries\",               \"supportedValues\":[\"US\"]}"

Required Parameters

--filterable-properties

Dictionary of filterable properties on product family. Expect value: KEY1=VALUE1 KEY2=VALUE2 ...

Optional Parameters

--expand

$expand is supported on configurations parameter for product, which provides details on the configurations for the product.

--location-placement-id

Location placement Id of a subscription.

--quota-id

Quota ID of a subscription.

--registered-features

List of registered feature flags for subscription.

Usage: --registered-features name=XX state=XX

name: Name of subscription registered feature state: State of subscription registered feature

Multiple actions can be specified by using more than one --registered-features argument.

--skip-token

$skipToken is supported on list of product families, which provides the next page in the list of product families.

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 edgeorder list-metadata

This method provides the list of product families metadata for the given subscription.

az edgeorder list-metadata [--skip-token]

Examples

ListProductFamiliesMetadata

az edgeorder list-metadata

Optional Parameters

--skip-token

$skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata.

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.