Share via

az afd origin-group

  • Reference

Manage origin groups under the specified profile.

Commands

Name Description Type Status
az afd origin-group create

Create a new origin group within the specified profile.

 Core GA
az afd origin-group delete

Delete an existing origin group within a profile.

 Core GA
az afd origin-group list

List all of the existing origin groups within a profile.

 Core GA
az afd origin-group show

Get an existing origin group within a profile.

 Core GA
az afd origin-group update

Update a new origin group within the specified profile.

 Core GA
az afd origin-group wait

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

 Core GA

az afd origin-group create

Create a new origin group within the specified profile.

az afd origin-group create --name
                           --profile-name
                           --resource-group
                           [--additional-latency-in-milliseconds]
                           [--enable-health-probe {0, 1, f, false, n, no, t, true, y, yes}]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--probe-interval-in-seconds]
                           [--probe-path]
                           [--probe-protocol {Http, Https, NotSet}]
                           [--probe-request-type {GET, HEAD, NotSet}]
                           [--sample-size]
                           [--session-affinity-state {Disabled, Enabled}]
                           [--successful-samples-required]
                           [--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]

Examples

Creates a new origin group within the specified profile.

az afd origin-group create -g group --origin-group-name og1 --profile-name profile --probe-request-type GET --probe-protocol Http --probe-interval-in-seconds 120 --probe-path /test1/azure.txt --sample-size 4 --successful-samples-required 3 --additional-latency-in-milliseconds 50

Required Parameters

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

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

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium 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

--additional-latency-in-milliseconds

The additional latency in milliseconds for probes to fall into the lowest latency bucket.

--enable-health-probe

Indicates whether to enable probe on the origin group.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--probe-interval-in-seconds

The number of seconds between health probes.Default is 240sec.

--probe-path

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

--probe-protocol

Protocol to use for health probe.

Accepted values: Http, Https, NotSet
--probe-request-type

The type of health probe request that is made.

Accepted values: GET, HEAD, NotSet
--sample-size

The number of samples to consider for load balancing decisions.

--session-affinity-state

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.

Accepted values: Disabled, Enabled
--successful-samples-required

The number of samples within the sample period that must succeed.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd origin-group delete

Delete an existing origin group within a profile.

az afd origin-group delete [--ids]
                           [--name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--profile-name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Deletes an existing origin group within a profile.

az afd origin-group delete -g group --origin-group-name og1 --profile-name profile

Optional Parameters

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

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

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium 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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd origin-group list

List all of the existing origin groups within a profile.

az afd origin-group list --profile-name
                         --resource-group
                         [--max-items]
                         [--next-token]

Required Parameters

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium 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

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

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd origin-group show

Get an existing origin group within a profile.

az afd origin-group show [--ids]
                         [--name]
                         [--profile-name]
                         [--resource-group]
                         [--subscription]

Optional Parameters

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

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

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

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium 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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd origin-group update

Update a new origin group within the specified profile.

az afd origin-group update [--add]
                           [--additional-latency-in-milliseconds]
                           [--enable-health-probe {0, 1, f, false, n, no, t, true, y, yes}]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--probe-interval-in-seconds]
                           [--probe-path]
                           [--probe-protocol {Http, Https, NotSet}]
                           [--probe-request-type {GET, HEAD, NotSet}]
                           [--profile-name]
                           [--remove]
                           [--resource-group]
                           [--sample-size]
                           [--session-affinity-state {Disabled, Enabled}]
                           [--set]
                           [--subscription]
                           [--successful-samples-required]
                           [--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]

Examples

Update the probe setting of the specified origin group.

az afd origin-group update -g group --origin-group-name og1 --profile-name profile --probe-request-type HEAD --probe-protocol Https --probe-interval-in-seconds 120 --probe-path /test1/azure.txt

Optional Parameters

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

--additional-latency-in-milliseconds

The additional latency in milliseconds for probes to fall into the lowest latency bucket.

--enable-health-probe

Indicates whether to enable probe on the origin group.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

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

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--probe-interval-in-seconds

The number of seconds between health probes.Default is 240sec.

--probe-path

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

--probe-protocol

Protocol to use for health probe.

Accepted values: Http, Https, NotSet
--probe-request-type

The type of health probe request that is made.

Accepted values: GET, HEAD, NotSet
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sample-size

The number of samples to consider for load balancing decisions.

--session-affinity-state

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.

Accepted values: Disabled, Enabled
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--successful-samples-required

The number of samples within the sample period that must succeed.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd origin-group wait

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

az afd origin-group wait [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--name]
                         [--profile-name]
                         [--resource-group]
                         [--subscription]
                         [--timeout]
                         [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--name --origin-group-name -n

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

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium 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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.