Share via

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

Edit

Create a new origin within the specified endpoint.

az cdn origin create --endpoint-name
                     --name --origin-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 443

Create 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

--endpoint-name

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

--name --origin-name -n

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

--disabled

Don't use the origin for load balancing.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enabled

Origin is enabled for load balancing or not.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--host-name

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

Property Value
Parameter group: Properties Arguments
--http-port

The value of the HTTP port. Must be between 1 and 65535.

Property Value
Parameter group: Properties Arguments
--https-port

The value of the HTTPS port. Must be between 1 and 65535.

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
--origin-host-header

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.

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

Property Value
Parameter group: Properties Arguments
--private-link-alias

The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.

Property Value
Parameter group: Properties Arguments
--private-link-approval-message -m

A custom message to be included in the approval request to connect to the Private Link.

Property Value
Parameter group: Properties Arguments
--private-link-location -l

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

Property Value
Parameter group: Properties Arguments
--private-link-resource-id -p

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

Property Value
Parameter group: Properties Arguments
--weight

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

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 delete

Edit

Delete an existing origin within an endpoint.

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

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

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

Edit

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

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

Edit

Get an existing origin within an endpoint.

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

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

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

Edit

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

Disable an origin

az cdn origin update -g group --profile-name profile --endpoint-name endpoint -n origin --disabled

Connect 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

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

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

Don't use the origin for load balancing.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enabled

Origin is enabled for load balancing or not.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--host-name

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

Property Value
Parameter group: Properties Arguments
--http-port

The value of the HTTP port. Must be between 1 and 65535.

Property Value
Parameter group: Properties Arguments
--https-port

The value of the HTTPS port. Must be between 1 and 65535.

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

Name of the origin 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
--origin-host-header

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.

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

Property Value
Parameter group: Properties Arguments
--private-link-alias

The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.

Property Value
Parameter group: Properties Arguments
--private-link-approval-message -m

A custom message to be included in the approval request to connect to the Private Link.

Property Value
Parameter group: Properties Arguments
--private-link-location -l

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

Property Value
Parameter group: Properties Arguments
--private-link-resource-id -p

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

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

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

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 wait

Edit

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

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

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --origin-name -n

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