az afd origin

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

Manage origins within the specified origin group.

Origins are the application servers where Front Door will route your client requests. Utilize any publicly accessible application server, including App Service, Traffic Manager, Private Link, and many others.

Commands

Name	Description	Type	Status
az afd origin create	Create an AFD origin.	Core	Preview
az afd origin delete	Deletes an existing origin within an origin group.	Core	Preview
az afd origin list	Lists all of the existing origins within an origin group.	Core	Preview
az afd origin show	Gets an existing origin within an origin group.	Core	Preview
az afd origin update	Update the settings of the specified AFD origin.	Core	Preview

az afd origin create

Preview

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

Create an AFD origin.

az afd origin create --enabled-state {Disabled, Enabled}
                     --host-name
                     --origin-group-name
                     --origin-name
                     --profile-name
                     --resource-group
                     [--enable-private-link {false, true}]
                     [--enforce-certificate-name-check {false, true}]
                     [--http-port]
                     [--https-port]
                     [--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

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

--enabled-state

Whether to enable this origin.

accepted values: Disabled, Enabled

--host-name

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

--origin-group-name

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

--origin-name

Name of the origin.

--profile-name

Name of the CDN 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

--enable-private-link

Indicates whether private link is enanbled on that origin.

accepted values: false, true

--enforce-certificate-name-check

"Whether to enable certificate name check at origin level.

accepted values: false, true

default value: True

--http-port

The port used for http requests to the origin.

default value: 80

--https-port

The port used for https requests to the origin.

default value: 443

--origin-host-header

The Host header to send for requests to this origin. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

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

default value: 1

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

default value: 1000

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

Preview

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

Deletes an existing origin within an origin group.

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

Optional Parameters

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

--origin-group-name

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

--origin-name

Name of the origin.

--profile-name

Name of the CDN 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>.

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False

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

Preview

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

Lists all of the existing origins within an origin group.

az afd origin list --origin-group-name
                   --profile-name
                   --resource-group

Required Parameters

--origin-group-name

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

--profile-name

Name of the CDN 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>.

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

Preview

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

Gets an existing origin within an origin group.

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

Optional Parameters

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

--origin-group-name

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

--origin-name

Name of the origin.

--profile-name

Name of the CDN 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>.

--subscription

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

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

Preview

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

Update the settings of the specified AFD origin.

az afd origin update [--enable-private-link {false, true}]
                     [--enabled-state {Disabled, Enabled}]
                     [--enforce-certificate-name-check {false, true}]
                     [--host-name]
                     [--http-port]
                     [--https-port]
                     [--ids]
                     [--origin-group-name]
                     [--origin-host-header]
                     [--origin-name]
                     [--priority]
                     [--private-link-location]
                     [--private-link-request-message]
                     [--private-link-resource]
                     [--private-link-sub-resource-type]
                     [--profile-name]
                     [--resource-group]
                     [--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

--enable-private-link

Indicates whether private link is enanbled on that origin.

accepted values: false, true

--enabled-state

Whether to enable this origin.

accepted values: Disabled, Enabled

--enforce-certificate-name-check

"Whether to enable certificate name check at origin level.

accepted values: false, true

--host-name

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

--http-port

The port used for http requests to the origin.

--https-port

The port used for https requests to the origin.

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

--origin-group-name

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

--origin-host-header

The Host header to send for requests to this origin. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

--origin-name

Name of the origin.

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

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

--subscription

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

--weight

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

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.