Share via

az afd origin

Manage origins within the specified origin group.

Commands

Name Description Type Status
az afd origin create

Create a new origin within the specified origin group.

 Core GA
az afd origin delete

Delete an existing origin within an origin group.

 Core GA
az afd origin list

List all of the existing origins within an origin group.

 Core GA
az afd origin show

Get an existing origin within an origin group.

 Core GA
az afd origin update

Update a new origin within the specified origin group.

 Core GA
az afd origin wait

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

 Core GA

az afd origin create

Create a new origin within the specified origin group.

az afd origin create --name --origin-name
                     --origin-group-name
                     --profile-name
                     --resource-group
                     [--enable-private-link {0, 1, f, false, n, no, t, true, y, yes}]
                     [--enabled-state {Disabled, Enabled}]
                     [--enforce-certificate-name-check {0, 1, f, false, n, no, t, true, y, yes}]
                     [--host-name]
                     [--http-port]
                     [--https-port]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--origin-host-header]
                     [--priority]
                     [--private-link-location]
                     [--private-link-request-message]
                     [--private-link-resource]
                     [--private-link-sub-resource-type]
                     [--weight]

Examples

Create an regular origin

az afd origin create -g group --host-name example.contoso.com --profile-name profile --origin-group-name originGroup --origin-name origin1 --origin-host-header example.contoso.com --priority 1 --weight 500 --enabled-state Enabled --http-port 80 --https-port 443 - name: Create a private link origin

Create a private link origin

az afd origin create -g group --host-name example.contoso.com --profile-name profile --origin-group-name originGroup --origin-name origin1 --origin-host-header example.contoso.com --priority 1 --weight 500 --enabled-state Enabled --http-port 80 --https-port 443 --private-link-resource /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group/providers/Microsoft.Storage/storageAccounts/plstest --private-link-location EastUS --private-link-request-message 'Please approve this request' --private-link-sub-resource-type table

Required Parameters

--name --origin-name -n

Name of the origin that is unique within the profile.

--origin-group-name

Name of the origin group which is unique within the profile.

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the 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.

--enable-private-link

Indicates whether private link is enabled on that origin.

Property Value
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. When an origin is disabled, both routing and health probes to the origin are also disabled.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--enforce-certificate-name-check

Whether to enable certificate name check at origin level.

Property Value
Parameter group: Properties Arguments
Default value: True
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--host-name

The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.

Property Value
Parameter group: Properties Arguments
--http-port

The value of the HTTP port. Must be between 1 and 65535.

Property Value
Parameter group: Properties Arguments
Default value: 80
--https-port

The value of the HTTPS port. Must be between 1 and 65535.

Property Value
Parameter group: Properties Arguments
Default value: 443
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--origin-host-header

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.

Property Value
Parameter group: Properties Arguments
--priority

Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.

Property Value
Parameter group: Properties Arguments
--private-link-location

The location of origin that will be connected to using the private link.

--private-link-request-message

The message that is shown to the approver of the private link request.

--private-link-resource

The resource ID of the origin that will be connected to using the private link.

--private-link-sub-resource-type

The sub-resource type of the origin that will be connected to using the private link.You can use "az network private-link-resource list" to obtain the supported sub-resource types.

--weight

Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.

Property Value
Parameter group: Properties 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.

--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 afd origin delete

Delete an existing origin within an origin group.

az afd origin delete [--ids]
                     [--name --origin-name]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--origin-group-name]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]
                     [--yes]

Optional Parameters

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

--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
--name --origin-name -n

Name of the origin which is unique within the profile.

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

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--origin-group-name

Name of the origin group which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

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
--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 afd origin list

List all of the existing origins within an origin group.

az afd origin list --origin-group-name
                   --profile-name
                   --resource-group
                   [--max-items]
                   [--next-token]

Required Parameters

--origin-group-name

Name of the origin group which is unique within the profile.

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the 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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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.

--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 afd origin show

Get an existing origin within an origin group.

az afd origin show [--ids]
                   [--name --origin-name]
                   [--origin-group-name]
                   [--profile-name]
                   [--resource-group]
                   [--subscription]

Optional Parameters

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

--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
--name --origin-name -n

Name of the origin which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--origin-group-name

Name of the origin group which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

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 afd origin update

Update a new origin within the specified origin group.

az afd origin update [--add]
                     [--enable-private-link {0, 1, f, false, n, no, t, true, y, yes}]
                     [--enabled-state {Disabled, Enabled}]
                     [--enforce-certificate-name-check {0, 1, f, false, n, no, t, true, y, yes}]
                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                     [--host-name]
                     [--http-port]
                     [--https-port]
                     [--ids]
                     [--name --origin-name]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--origin-group-name]
                     [--origin-host-header]
                     [--priority]
                     [--private-link-location]
                     [--private-link-request-message]
                     [--private-link-resource]
                     [--private-link-sub-resource-type]
                     [--profile-name]
                     [--remove]
                     [--resource-group]
                     [--set]
                     [--subscription]
                     [--weight]

Examples

Update the host header and priority of the specified origin.

az afd origin update -g group --host-name example.contoso.com --profile-name profile --origin-group-name originGroup --origin-name origin1 --origin-host-header example.contoso.com --priority 3

Disable private link of the origin.

az afd origin update -g group --host-name example.contoso.com --profile-name profile --origin-group-name originGroup --origin-name origin1 --enable-private-link False

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--enable-private-link

Indicates whether private link is enabled on that origin.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. When an origin is disabled, both routing and health probes to the origin are also disabled.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--enforce-certificate-name-check

Whether to enable certificate name check at origin level.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--host-name

The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.

Property Value
Parameter group: Properties Arguments
--http-port

The value of the HTTP port. Must be between 1 and 65535.

Property Value
Parameter group: Properties Arguments
--https-port

The value of the HTTPS port. Must be between 1 and 65535.

Property Value
Parameter group: Properties 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
--name --origin-name -n

Name of the origin which is unique within the profile.

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

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--origin-group-name

Name of the origin group which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--origin-host-header

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.

Property Value
Parameter group: Properties Arguments
--priority

Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.

Property Value
Parameter group: Properties Arguments
--private-link-location

The location of origin that will be connected to using the private link.

--private-link-request-message

The message that is shown to the approver of the private link request.

--private-link-resource

The resource ID of the origin that will be connected to using the private link.

--private-link-sub-resource-type

The sub-resource type of the origin that will be connected to using the private link.You can use "az network private-link-resource list" to obtain the supported sub-resource types.

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update 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
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update 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
--weight

Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.

Property Value
Parameter group: Properties 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 afd origin wait

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

az afd origin wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--ids]
                   [--interval]
                   [--name --origin-name]
                   [--origin-group-name]
                   [--profile-name]
                   [--resource-group]
                   [--subscription]
                   [--timeout]
                   [--updated]

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --origin-name -n

Name of the origin which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--origin-group-name

Name of the origin group which is unique within the profile.

Property Value
Parameter group: Resource Id Arguments
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

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

--verbose

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

Property Value
Default value: False