az afd origin-group

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 --origin-group-name
                           --profile-name
                           --resource-group
                           [--additional-latency-in-milliseconds]
                           [--enable-health-probe {0, 1, f, false, n, no, t, true, y, yes}]
                           [--health-probe-settings]
                           [--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 --resource-group RG --profile-name profile1 --origin-group-name origingroup1 --sample-size 3 --successful-samples-required 3 --additional-latency-in-milliseconds 1000 --health-probe-settings "{probe-path:/path2,probe-request-type:NotSet,probe-protocol:NotSet,probe-interval-in-seconds:10}" --traffic-restoration-time-to-healed-or-new-endpoints-in-minutes 5

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

--additional-latency-in-milliseconds

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

Property	Value
Parameter group:	LoadBalancingSettings Arguments

--enable-health-probe

Indicates whether to enable probe on the origin group.

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

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

--probe-interval-in-seconds

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

Property	Value
Parameter group:	HealthProbeSettings Arguments

--probe-path

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

Property	Value
Parameter group:	HealthProbeSettings Arguments

--probe-protocol

Protocol to use for health probe.

Property	Value
Parameter group:	HealthProbeSettings Arguments
Accepted values:	Http, Https, NotSet

--probe-request-type

The type of health probe request that is made.

Property	Value
Parameter group:	HealthProbeSettings Arguments
Accepted values:	GET, HEAD, NotSet

--sample-size

The number of samples to consider for load balancing decisions.

Property	Value
Parameter group:	LoadBalancingSettings Arguments

--session-affinity-state

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--successful-samples-required

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

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

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

Delete an existing origin group within a profile.

az afd origin-group delete [--ids]
                           [--name --origin-group-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

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

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

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

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

Get an existing origin group within a profile.

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

Examples

Get an existing origin group within a profile.

az afd origin-group show --resource-group RG --profile-name profile1 --origin-group-name origingroup1

Optional Parameters

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

--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 Azure Front Door Standard or Azure Front Door Premium 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 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}]
                           [--health-probe-settings]
                           [--ids]
                           [--name --origin-group-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 a new origin group within the specified profile.

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

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

--additional-latency-in-milliseconds

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

Property	Value
Parameter group:	LoadBalancingSettings Arguments

--enable-health-probe

Indicates whether to enable probe on the origin group.

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--probe-interval-in-seconds

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

Property	Value
Parameter group:	HealthProbeSettings Arguments

--probe-path

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

Property	Value
Parameter group:	HealthProbeSettings Arguments

--probe-protocol

Protocol to use for health probe.

Property	Value
Parameter group:	HealthProbeSettings Arguments
Accepted values:	Http, Https, NotSet

--probe-request-type

The type of health probe request that is made.

Property	Value
Parameter group:	HealthProbeSettings Arguments
Accepted values:	GET, HEAD, NotSet

--profile-name

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

--sample-size

The number of samples to consider for load balancing decisions.

Property	Value
Parameter group:	LoadBalancingSettings Arguments

--session-affinity-state

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

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

--successful-samples-required

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

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

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

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

Share via

az afd origin-group

Commands

az afd origin-group create

Examples

Required Parameters

Optional Parameters

az afd origin-group delete

Examples

Optional Parameters

az afd origin-group list

Required Parameters

Optional Parameters

az afd origin-group show

Examples

Optional Parameters

az afd origin-group update

Examples

Optional Parameters

az afd origin-group wait

Optional Parameters

Feedback