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.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az afd origin create |
Create a new origin within the specified origin group. |
Core | Preview |
| az afd origin delete |
Delete an existing origin within an origin group. |
Core | Preview |
| az afd origin list |
List all of the existing origins within an origin group. |
Core | Preview |
| az afd origin show |
Get an existing origin within an origin group. |
Core | Preview |
| az afd origin update |
Update a new origin within the specified origin group. |
Core | Preview |
| az afd origin wait |
Place the CLI in a waiting state until a condition is met. |
Core | Preview |
az afd origin create
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a new origin within the specified origin group.
az afd origin create --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 originCreate 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 tableRequired Parameters
Name of the origin that is unique within the profile.
Name of the origin group which is unique within the profile.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Indicates whether private link is enanbled on that origin.
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.
Whether to enable certificate name check at origin level.
The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
The value of the HTTP port. Must be between 1 and 65535.
The value of the HTTPS port. Must be between 1 and 65535.
Do not wait for the long-running operation to finish.
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.
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.
The location of origin that will be connected to using the private link.
The message that is shown to the approver of the private link request.
The resource ID of the origin that will be connected to using the private link.
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 of the origin in given origin group for load balancing. Must be between 1 and 1000.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az afd origin delete
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an existing origin within an origin group.
az afd origin delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--origin-group-name]
[--profile-name]
[--resource-group]
[--subscription]
[--yes]Optional Parameters
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.
Name of the origin which is unique within the profile.
Do not wait for the long-running operation to finish.
Name of the origin group which is unique within the profile.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az afd origin list
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
Name of the origin group which is unique within the profile.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az afd origin show
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get an existing origin within an origin group.
az afd origin show [--ids]
[--name]
[--origin-group-name]
[--profile-name]
[--resource-group]
[--subscription]Optional Parameters
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.
Name of the origin which is unique within the profile.
Name of the origin group which is unique within the profile.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az afd origin update
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--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 3Disable 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 FalseOptional Parameters
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>.
Indicates whether private link is enanbled on that origin.
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.
Whether to enable certificate name check at origin level.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
The value of the HTTP port. Must be between 1 and 65535.
The value of the HTTPS port. Must be between 1 and 65535.
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.
Name of the origin which is unique within the profile.
Do not wait for the long-running operation to finish.
Name of the origin group which is unique within the profile.
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.
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.
The location of origin that will be connected to using the private link.
The message that is shown to the approver of the private link request.
The resource ID of the origin that will be connected to using the private link.
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.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az afd origin wait
Command group 'afd' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az afd origin wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--origin-group-name]
[--profile-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of the origin which is unique within the profile.
Name of the origin group which is unique within the profile.
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for