origin-group.yml

### YamlMime:AzureCLIGroup
uid: az_afd_origin-group
name: az afd origin-group
summary: |-
  Manage origin groups under the specified profile.
status: GA
sourceType: Core
directCommands:
- uid: az_afd_origin-group_create
  name: az afd origin-group create
  summary: |-
    Create a new origin group within the specified profile.
  status: GA
  sourceType: Core
  syntax: >-
    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:
  - summary: |-
      Creates a new origin group within the specified profile.
    syntax: 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
  requiredParameters:
  - isRequired: true
    name: --name --origin-group-name -n
    summary: |-
      Name of the origin group which is unique within the endpoint.
  - isRequired: true
    name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --additional-latency-in-milliseconds
    summary: |-
      The additional latency in milliseconds for probes to fall into the lowest latency bucket.
  - name: --enable-health-probe
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Indicates whether to enable probe on the origin group.
  - name: --no-wait
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --probe-interval-in-seconds
    summary: |-
      The number of seconds between health probes.Default is 240sec.
  - name: --probe-path
    summary: |-
      The path relative to the origin that is used to determine the health of the origin.
  - name: --probe-protocol
    parameterValueGroup: "Http, Https, NotSet"
    summary: |-
      Protocol to use for health probe.
  - name: --probe-request-type
    parameterValueGroup: "GET, HEAD, NotSet"
    summary: |-
      The type of health probe request that is made.
  - name: --sample-size
    summary: |-
      The number of samples to consider for load balancing decisions.
  - name: --session-affinity-state
    parameterValueGroup: "Disabled, Enabled"
    summary: |-
      Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.
  - name: --successful-samples-required
    summary: |-
      The number of samples within the sample period that must succeed.
  - name: --traffic-restoration-time-to-healed-or-new-endpoints-in-minutes
    summary: |-
      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.
- uid: az_afd_origin-group_delete
  name: az afd origin-group delete
  summary: |-
    Delete an existing origin group within a profile.
  status: GA
  sourceType: Core
  syntax: >-
    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:
  - summary: |-
      Deletes an existing origin group within a profile.
    syntax: az afd origin-group delete -g group --origin-group-name og1 --profile-name profile
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name --origin-group-name -n
    summary: |-
      Name of the origin group which is unique within the profile.
  - name: --no-wait
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
- uid: az_afd_origin-group_list
  name: az afd origin-group list
  summary: |-
    List all of the existing origin groups within a profile.
  status: GA
  sourceType: Core
  syntax: >-
    az afd origin-group list --profile-name
                             --resource-group
                             [--max-items]
                             [--next-token]
  requiredParameters:
  - isRequired: true
    name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --max-items
    summary: |-
      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.
  - name: --next-token
    summary: |-
      Token to specify where to start paginating. This is the token value from a previously truncated response.
- uid: az_afd_origin-group_show
  name: az afd origin-group show
  summary: |-
    Get an existing origin group within a profile.
  status: GA
  sourceType: Core
  syntax: >-
    az afd origin-group show [--ids]
                             [--name]
                             [--profile-name]
                             [--resource-group]
                             [--subscription]
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name --origin-group-name -n
    summary: |-
      Name of the origin group which is unique within the endpoint.
  - name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_afd_origin-group_update
  name: az afd origin-group update
  summary: |-
    Update a new origin group within the specified profile.
  status: GA
  sourceType: Core
  syntax: >-
    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:
  - summary: |-
      Update the probe setting of the specified origin group.
    syntax: 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
  optionalParameters:
  - name: --add
    summary: |-
      Add an object to a list of objects by specifying a path and key value pairs.  Example: `--add property.listProperty <key=value, string or JSON string>`.
  - name: --additional-latency-in-milliseconds
    summary: |-
      The additional latency in milliseconds for probes to fall into the lowest latency bucket.
  - name: --enable-health-probe
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Indicates whether to enable probe on the origin group.
  - name: --force-string
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
  - name: --ids
    summary: |-
      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: --name --origin-group-name -n
    summary: |-
      Name of the origin group which is unique within the endpoint.
  - name: --no-wait
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --probe-interval-in-seconds
    summary: |-
      The number of seconds between health probes.Default is 240sec.
  - name: --probe-path
    summary: |-
      The path relative to the origin that is used to determine the health of the origin.
  - name: --probe-protocol
    parameterValueGroup: "Http, Https, NotSet"
    summary: |-
      Protocol to use for health probe.
  - name: --probe-request-type
    parameterValueGroup: "GET, HEAD, NotSet"
    summary: |-
      The type of health probe request that is made.
  - name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - name: --remove
    summary: |-
      Remove a property or an element from a list.  Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --sample-size
    summary: |-
      The number of samples to consider for load balancing decisions.
  - name: --session-affinity-state
    parameterValueGroup: "Disabled, Enabled"
    summary: |-
      Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.
  - name: --set
    summary: |-
      Update an object by specifying a property path and value to set.  Example: `--set property1.property2=<value>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --successful-samples-required
    summary: |-
      The number of samples within the sample period that must succeed.
  - name: --traffic-restoration-time-to-healed-or-new-endpoints-in-minutes
    summary: |-
      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.
- uid: az_afd_origin-group_wait
  name: az afd origin-group wait
  summary: |-
    Place the CLI in a waiting state until a condition is met.
  status: GA
  sourceType: Core
  syntax: >-
    az afd origin-group wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--profile-name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]
  optionalParameters:
  - name: --created
    defaultValue: "False"
    summary: |-
      Wait until created with 'provisioningState' at 'Succeeded'.
  - name: --custom
    summary: |-
      Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
  - name: --deleted
    defaultValue: "False"
    summary: |-
      Wait until deleted.
  - name: --exists
    defaultValue: "False"
    summary: |-
      Wait until the resource exists.
  - name: --ids
    summary: |-
      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: --interval
    defaultValue: "30"
    summary: |-
      Polling interval in seconds.
  - name: --name --origin-group-name -n
    summary: |-
      Name of the origin group which is unique within the endpoint.
  - name: --profile-name
    summary: |-
      Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --timeout
    defaultValue: "3600"
    summary: |-
      Maximum wait in seconds.
  - name: --updated
    defaultValue: "False"
    summary: |-
      Wait until updated with provisioningState at 'Succeeded'.
commands:
- az_afd_origin-group_create
- az_afd_origin-group_delete
- az_afd_origin-group_list
- az_afd_origin-group_show
- az_afd_origin-group_update
- az_afd_origin-group_wait
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Manage origin groups under the specified profile.