Share via

az edgeorder address

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 address command. Learn more about extensions.

Manage address with edgeorder sub group address.

Commands

Name Description Type Status
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 address create

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

az edgeorder address create --address-name --name
                            --contact-details
                            --resource-group
                            [--___location]
                            [--no-wait]
                            [--shipping-address]
                            [--tags]

Examples

CreateAddress

az edgeorder address create --name "TestMSAddressName" --___location "eastus" --contact-details contact-name="Petr Cech" email-list="testemail@microsoft.com" phone="1234567890" phone-extension="" --shipping-address address-type="None" city="San Francisco" company-name="Microsoft" country="US" postal-code="94107" state-or-province="CA" street-address1="16 TOWNSEND ST" street-address2="UNIT 1" --resource-group "TestRG"

Required Parameters

--address-name --name -n

The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

--contact-details

Contact details for the address.

Usage: --contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX

contact-name: Required. Contact name of the person. phone: Required. Phone number of the contact person. phone-extension: Phone extension number of the contact person. mobile: Mobile number of the contact person. email-list: Required. List of Email-ids to be notified about job progress.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--___location -l

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

--no-wait

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

Property Value
Default value: False
--shipping-address

Shipping details for the address.

Usage: --shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX postal-code=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1: Required. Street Address line 1. street-address2: Street Address line 2. street-address3: Street Address line 3. city: Name of the City. state-or-province: Name of the State or Province. country: Required. Name of the Country. postal-code: Postal code. zip-extended-code: Extended Zip Code. company-name: Name of the company. address-type: Type of address.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 edgeorder address delete

Delete an address.

az edgeorder address delete [--address-name --name]
                            [--ids]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

DeleteAddressByName

az edgeorder address delete --name "TestAddressName1" --resource-group "TestRG"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-name --name -n

The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az edgeorder address list

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

az edgeorder address list [--filter]
                          [--resource-group]
                          [--skip-token]

Examples

ListAddressesAtResourceGroupLevel

az edgeorder address list --resource-group "TestRG"

ListAddressesAtSubscriptionLevel

az edgeorder address list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

$filter is supported to filter based on shipping address properties. Filter supports only equals operation.

--resource-group -g

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

--skip-token

$skipToken is supported on Get list of addresses, which provides the next page in the list of address.

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 edgeorder address show

Get information about the specified address.

az edgeorder address show [--address-name --name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

Examples

GetAddressByName

az edgeorder address show --name "TestMSAddressName" --resource-group "TestRG"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-name --name -n

The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az edgeorder address update

Update the properties of an existing address.

az edgeorder address update [--address-name --name]
                            [--contact-details]
                            [--ids]
                            [--if-match]
                            [--no-wait]
                            [--resource-group]
                            [--shipping-address]
                            [--subscription]
                            [--tags]

Examples

UpdateAddress

az edgeorder address update --name "TestAddressName2" --contact-details contact-name="Petr Cech" email-list="ssemcr@microsoft.com" phone="1234567890" phone-extension="" --shipping-address address-type="None" city="San Francisco" company-name="Microsoft" country="US" postal-code="94107" state-or-province="CA" street-address1="16 TOWNSEND STT" street-address2="UNIT 1" --tags Hobby="Web Series Added" Name="Smile-Updated" WhatElse="Web Series Added" Work="Engineering" --resource-group "TestRG"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-name --name -n

The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.

Property Value
Parameter group: Resource Id Arguments
--contact-details

Contact details for the address.

Usage: --contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX

contact-name: Required. Contact name of the person. phone: Required. Phone number of the contact person. phone-extension: Phone extension number of the contact person. mobile: Mobile number of the contact person. email-list: Required. List of Email-ids to be notified about job progress.

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

Property Value
Parameter group: Resource Id Arguments
--if-match

Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

--no-wait

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

Property Value
Default value: False
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--shipping-address

Shipping details for the address.

Usage: --shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX postal-code=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1: Required. Street Address line 1. street-address2: Street Address line 2. street-address3: Street Address line 3. city: Name of the City. state-or-province: Name of the State or Province. country: Required. Name of the Country. postal-code: Postal code. zip-extended-code: Extended Zip Code. company-name: Name of the company. address-type: Type of address.

--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az edgeorder address wait

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

az edgeorder address wait --address-name
                          --resource-group
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

Required Parameters

--address-name

The name of the address Resource within the specified resource group.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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