az cdn origin-group
Manage origin groups of an endpoint.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az cdn origin-group create |
Create a new origin group within the specified endpoint. |
Core | GA |
| az cdn origin-group delete |
Delete an existing origin group within an endpoint. |
Core | GA |
| az cdn origin-group list |
List all of the existing origin groups within an endpoint. |
Core | GA |
| az cdn origin-group show |
Get an existing origin group within an endpoint. |
Core | GA |
| az cdn origin-group update |
Update a new origin group within the specified endpoint. |
Core | GA |
| az cdn origin-group wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az cdn origin-group create
Create a new origin group within the specified endpoint.
az cdn origin-group create --endpoint-name
--name
--profile-name
--resource-group
[--formatted-origins]
[--health-probe-settings]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--origins]
[--probe-interval]
[--probe-method]
[--probe-path]
[--probe-protocol]
[--response-based-origin-error-detection-settings]
[--response-error-detection-error-types]
[--response-error-detection-failover-threshold]
[--response-error-detection-status-code-ranges]
[--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]Examples
Create an origin group
az cdn origin-group create -g group --profile-name profile --endpoint-name endpoint -n origin-group --origins origin-0,origin-1Create an origin group with a custom health probe
az cdn origin-group create -g group --profile-name profile --endpoint-name endpoint -n origin-group --origins origin-0,origin-1 --probe-path /healthz --probe-interval 90 --probe-protocol HTTPS --probe-method GETRequired Parameters
Name of the endpoint under the profile which is unique globally.
Name of the origin group 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>.
Optional Parameters
The source of the content being delivered via CDN within given origin group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Health probe settings to the origin that is used to determine the health of the origin. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.
The frequency to perform health probes in seconds.
The request method to use for health probes.
The path relative to the origin that is used to determine the health of the origin.
The protocol to use for health probes.
The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
The percentage of failed requests in the sample where failover should trigger.
Type of response errors for real user requests for which origin will be deemed unhealthy.
Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
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-group delete
Delete an existing origin group within an endpoint.
az cdn origin-group 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 group 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-group list
List all of the existing origin groups within an endpoint.
az cdn origin-group 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-group show
Get an existing origin group within an endpoint.
az cdn origin-group 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 group 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-group update
Update a new origin group within the specified endpoint.
az cdn origin-group update [--add]
[--endpoint-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--formatted-origins]
[--health-probe-settings]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--origins]
[--probe-interval]
[--probe-method]
[--probe-path]
[--probe-protocol]
[--profile-name]
[--remove]
[--resource-group]
[--response-based-origin-error-detection-settings]
[--response-error-detection-error-types]
[--response-error-detection-failover-threshold]
[--response-error-detection-status-code-ranges]
[--set]
[--subscription]
[--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]Examples
Update which origins are included in an origin group.
az cdn origin-group update -g group --profile-name profile --endpoint-name endpoint -n origin-group --origins origin-0,origin-2Update an origin group with a custom health probe
az cdn origin-group update -g group --profile-name profile --endpoint-name endpoint -n origin-group --origins origin-0,origin-1 --probe-path /healthz --probe-interval 90 --probe-protocol HTTPS --probe-method GETOptional 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>.
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 source of the content being delivered via CDN within given origin group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Health probe settings to the origin that is used to determine the health of the origin. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 group which is unique within the endpoint.
Do not wait for the long-running operation to finish.
The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.
The frequency to perform health probes in seconds.
The request method to use for health probes.
The path relative to the origin that is used to determine the health of the origin.
The protocol to use for health probes.
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>.
The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
The percentage of failed requests in the sample where failover should trigger.
Type of response errors for real user requests for which origin will be deemed unhealthy.
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.
Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
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-group wait
Place the CLI in a waiting state until a condition is met.
az cdn origin-group 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 group 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