az cdn origin-group

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

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 create (cdn extension)	Create a new origin group within the specified endpoint.	Extension	GA
az cdn origin-group delete	Delete an existing origin group within an endpoint.	Core	GA
az cdn origin-group delete (cdn extension)	Delete an existing origin group within an endpoint.	Extension	GA
az cdn origin-group list	List all of the existing origin groups within an endpoint.	Core	GA
az cdn origin-group list (cdn extension)	List all of the existing origin groups within an endpoint.	Extension	GA
az cdn origin-group show	Get an existing origin group within an endpoint.	Core	GA
az cdn origin-group show (cdn extension)	Get an existing origin group within an endpoint.	Extension	GA
az cdn origin-group update	Update a new origin group within the specified endpoint.	Core	GA
az cdn origin-group update (cdn extension)	Update a new origin group within the specified endpoint.	Extension	GA
az cdn origin-group wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az cdn origin-group wait (cdn extension)	Place the CLI in a waiting state until a condition is met.	Extension	GA

az cdn origin-group create

Edit

Create a new origin group within the specified endpoint.

az cdn origin-group create --endpoint-name
                           --name --origin-group-name
                           --profile-name
                           --resource-group
                           [--acquire-policy-token]
                           [--change-reference]
                           [--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-1

Create 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 GET

Required Parameters

--endpoint-name

Name of the endpoint under the profile which is unique globally.

--name --origin-group-name -n

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--formatted-origins

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.

Property	Value
Parameter group:	Properties Arguments

--health-probe-settings

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.

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

--origins

The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.

--probe-interval

The frequency to perform health probes in seconds.

--probe-method

The request method to use for health probes.

--probe-path

The path relative to the origin that is used to determine the health of the origin.

--probe-protocol

The protocol to use for health probes.

--response-based-origin-error-detection-settings

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.

Property	Value
Parameter group:	Properties Arguments

--response-error-detection-error-types

The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

--response-error-detection-failover-threshold

The percentage of failed requests in the sample where failover should trigger.

--response-error-detection-status-code-ranges

Type of response errors for real user requests for which origin will be deemed unhealthy.

--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

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.

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 cdn origin-group create (cdn extension)

Create a new origin group within the specified endpoint.

az cdn origin-group create --endpoint-name
                           --name --origin-group-name
                           --profile-name
                           --resource-group
                           [--acquire-policy-token]
                           [--change-reference]
                           [--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-1

Create 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 GET

Required Parameters

--endpoint-name

Name of the endpoint under the profile which is unique globally.

--name --origin-group-name -n

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--formatted-origins

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.

Property	Value
Parameter group:	Properties Arguments

--health-probe-settings

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.

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

--origins

The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.

--probe-interval

The frequency to perform health probes in seconds.

--probe-method

The request method to use for health probes.

--probe-path

The path relative to the origin that is used to determine the health of the origin.

--probe-protocol

The protocol to use for health probes.

--response-based-origin-error-detection-settings

Property	Value
Parameter group:	Properties Arguments

--response-error-detection-error-types

The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

--response-error-detection-failover-threshold

The percentage of failed requests in the sample where failover should trigger.

--response-error-detection-status-code-ranges

Type of response errors for real user requests for which origin will be deemed unhealthy.

--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

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.

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 cdn origin-group delete

Edit

Delete an existing origin group within an endpoint.

az cdn origin-group delete [--acquire-policy-token]
                           [--change-reference]
                           [--endpoint-name]
                           [--ids]
                           [--name --origin-group-name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id 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-group-name -n

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

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

--profile-name

Name of the CDN 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 cdn origin-group delete (cdn extension)

Delete an existing origin group within an endpoint.

az cdn origin-group delete [--acquire-policy-token]
                           [--change-reference]
                           [--endpoint-name]
                           [--ids]
                           [--name --origin-group-name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --origin-group-name -n

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

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

--profile-name

Name of the CDN 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 cdn origin-group list

Edit

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

--endpoint-name

Name of the endpoint under the profile which is unique globally.

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

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 cdn origin-group list (cdn extension)

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

--endpoint-name

Name of the endpoint under the profile which is unique globally.

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

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

--max-items

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 cdn origin-group show

Edit

Get an existing origin group within an endpoint.

az cdn origin-group show [--endpoint-name]
                         [--ids]
                         [--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.

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --origin-group-name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of the CDN 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 cdn origin-group show (cdn extension)

Get an existing origin group within an endpoint.

az cdn origin-group show [--endpoint-name]
                         [--ids]
                         [--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.

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --origin-group-name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of the CDN 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 cdn origin-group update

Edit

Update a new origin group within the specified endpoint.

az cdn origin-group update [--acquire-policy-token]
                           [--add]
                           [--change-reference]
                           [--endpoint-name]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--formatted-origins]
                           [--health-probe-settings]
                           [--ids]
                           [--name --origin-group-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-2

Update 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 GET

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

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

--formatted-origins

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.

Property	Value
Parameter group:	Properties Arguments

--health-probe-settings

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.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --origin-group-name -n

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

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

--origins

The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.

--probe-interval

The frequency to perform health probes in seconds.

--probe-method

The request method to use for health probes.

--probe-path

The path relative to the origin that is used to determine the health of the origin.

--probe-protocol

The protocol to use for health probes.

--profile-name

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

--response-based-origin-error-detection-settings

Property	Value
Parameter group:	Properties Arguments

--response-error-detection-error-types

The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

--response-error-detection-failover-threshold

The percentage of failed requests in the sample where failover should trigger.

--response-error-detection-status-code-ranges

Type of response errors for real user requests for which origin will be deemed unhealthy.

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

--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

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.

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 cdn origin-group update (cdn extension)

Update a new origin group within the specified endpoint.

az cdn origin-group update [--acquire-policy-token]
                           [--add]
                           [--change-reference]
                           [--endpoint-name]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--formatted-origins]
                           [--health-probe-settings]
                           [--ids]
                           [--name --origin-group-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-2

Update 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 GET

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

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

--formatted-origins

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.

Property	Value
Parameter group:	Properties Arguments

--health-probe-settings

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.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --origin-group-name -n

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

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

--origins

The origins load balanced by this origin group, as a comma-separated list of origin names or origin resource IDs.

--probe-interval

The frequency to perform health probes in seconds.

--probe-method

The request method to use for health probes.

--probe-path

The path relative to the origin that is used to determine the health of the origin.

--probe-protocol

The protocol to use for health probes.

--profile-name

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

--response-based-origin-error-detection-settings

Property	Value
Parameter group:	Properties Arguments

--response-error-detection-error-types

The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.

--response-error-detection-failover-threshold

The percentage of failed requests in the sample where failover should trigger.

--response-error-detection-status-code-ranges

Type of response errors for real user requests for which origin will be deemed unhealthy.

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

--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

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.

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 cdn origin-group wait

Edit

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

az cdn origin-group wait [--acquire-policy-token]
                         [--change-reference]
                         [--created]
                         [--custom]
                         [--deleted]
                         [--endpoint-name]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --origin-group-name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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

az cdn origin-group wait (cdn extension)

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

az cdn origin-group wait [--acquire-policy-token]
                         [--change-reference]
                         [--created]
                         [--custom]
                         [--deleted]
                         [--endpoint-name]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--endpoint-name

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --origin-group-name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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

Feedback

Was this page helpful?