az cdn origin
List or show existing origins related to CDN endpoints.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az cdn origin create |
Create a new origin within the specified endpoint. |
Core | GA |
| az cdn origin delete |
Delete an existing origin within an endpoint. |
Core | GA |
| az cdn origin list |
List all of the existing origins within an endpoint. |
Core | GA |
| az cdn origin show |
Get an existing origin within an endpoint. |
Core | GA |
| az cdn origin update |
Update a new origin within the specified endpoint. |
Core | GA |
| az cdn origin wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az cdn origin create
Create a new origin within the specified endpoint.
az cdn origin create --endpoint-name
--name
--profile-name
--resource-group
[--disabled {0, 1, f, false, n, no, t, true, y, yes}]
[--enabled {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-alias]
[--private-link-approval-message]
[--private-link-location]
[--private-link-resource-id]
[--weight]Examples
Create an additional origin
az cdn origin create -g group --host-name example.contoso.com --profile-name profile --endpoint-name endpoint -n origin --host-name example.contoso.com --origin-host-header example.contoso.com --http-port 80 --https-port 443Create a private origin
az cdn origin create -g group --host-name example.contoso.com --profile-name profile --endpoint-name endpoint -n origin --http-port 80 --https-port 443 --private-link-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group/providers/Microsoft.Network/privateLinkServices/pls --private-link-location EastUS --private-link-approval-message 'Please approve this request'Required Parameters
Name of the endpoint under the profile which is unique globally.
Name of the origin that is unique within the endpoint.
Name of the CDN 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
Don't use the origin for load balancing.
Origin is enabled for load balancing or not.
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 CDN 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 Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.
A custom message to be included in the approval request to connect to the Private Link.
The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.
The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.
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 cdn origin delete
Delete an existing origin within an endpoint.
az cdn origin delete [--endpoint-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--profile-name]
[--resource-group]
[--subscription]
[--yes]Optional Parameters
Name of the endpoint under the profile which is unique globally.
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 endpoint.
Do not wait for the long-running operation to finish.
Name of the CDN 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 cdn origin list
List all of the existing origins within an endpoint.
az cdn origin list --endpoint-name
--profile-name
--resource-group
[--max-items]
[--next-token]Required Parameters
Name of the endpoint under the profile which is unique globally.
Name of the CDN 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 cdn origin show
Get an existing origin within an endpoint.
az cdn origin show [--endpoint-name]
[--ids]
[--name]
[--profile-name]
[--resource-group]
[--subscription]Optional Parameters
Name of the endpoint under the profile which is unique globally.
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 endpoint.
Name of the CDN 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 cdn origin update
Update a new origin within the specified endpoint.
az cdn origin update [--add]
[--disabled {0, 1, f, false, n, no, t, true, y, yes}]
[--enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--endpoint-name]
[--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-host-header]
[--priority]
[--private-link-alias]
[--private-link-approval-message]
[--private-link-location]
[--private-link-resource-id]
[--profile-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--weight]Examples
Update an origin
az cdn origin update -g group --profile-name profile --endpoint-name endpoint -n origin --http-port 80 --https-port 443 --priority 3 --weight 500 --host-name example.contoso.comDisable an origin
az cdn origin update -g group --profile-name profile --endpoint-name endpoint -n origin --disabledConnect an origin to a private link service
az cdn origin update -g group --profile-name profile --endpoint-name endpoint -n origin --http-port 80 --https-port 443 --private-link-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group/providers/Microsoft.Network/privateLinkServices/pls --private-link-location EastUS --private-link-approval-message 'Please approve this request'Optional 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>.
Don't use the origin for load balancing.
Origin is enabled for load balancing or not.
Name of the endpoint under the profile which is unique globally.
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 endpoint.
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 CDN 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 Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.
A custom message to be included in the approval request to connect to the Private Link.
The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.
The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.
Name of the CDN 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 cdn origin wait
Place the CLI in a waiting state until a condition is met.
az cdn origin wait [--created]
[--custom]
[--deleted]
[--endpoint-name]
[--exists]
[--ids]
[--interval]
[--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.
Name of the endpoint under the profile which is unique globally.
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 endpoint.
Name of the CDN 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