Share via

az fleet gate

  • Preview

Note

This reference is part of the fleet extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az fleet gate command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage gates.

Commands

Name Description Type Status
az fleet gate approve

Approves a gate, and sets the gate state to Completed. This modifies the gate state in the same way as the general-purpose update command, however it's simpler to use.

 Extension Preview
az fleet gate list

Lists all gates under a fleet.

 Extension Preview
az fleet gate show

Shows a specific gate.

 Extension Preview
az fleet gate update

Updates a gate. Currently only the gate state can be updated. Valid values are ('Completed').

 Extension Preview

az fleet gate approve

Preview

Command group 'fleet gate' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Approves a gate, and sets the gate state to Completed. This modifies the gate state in the same way as the general-purpose update command, however it's simpler to use.

az fleet gate approve --fleet-name
                      --gate --gate-name
                      --resource-group

Examples

Approves a gate.

az fleet gate approve -g MyFleetResourceGroup --fleet-name MyFleetName --gate-name 3fa85f64-5717-4562-b3fc-2c963f66afa6

Required Parameters

--fleet-name -f

Name of the fleet.

--gate --gate-name -n

Name of the gate.

--resource-group -g

Name of the resource group.

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 fleet gate list

Preview

Command group 'fleet gate' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all gates under a fleet.

az fleet gate list --fleet-name
                   --resource-group
                   [--state --state-filter]

Examples

Lists all gates under a fleet.

az fleet gate list -g MyFleetResourceGroup --fleet-name MyFleetName

List all gates, filtering on gate state. Valid values are ('Pending', 'Skipped', 'Completed').

az fleet gate list -g MyFleetResourceGroup --fleet-name MyFleetName --state Pending

Required Parameters

--fleet-name -f

Name of the fleet.

--resource-group -g

Name of the resource group.

Optional Parameters

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

--state --state-filter

Apply a filter on gate state. Valid values are: Pending, Skipped, Completed.

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

Preview

Command group 'fleet gate' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Shows a specific gate.

az fleet gate show --fleet-name
                   --gate --gate-name --name
                   --resource-group

Examples

Shows a specific gate.

az fleet gate show -g MyFleetResourceGroup -f MyFleetName -n 3fa85f64-5717-4562-b3fc-2c963f66afa6

Required Parameters

--fleet-name -f

Name of the fleet.

--gate --gate-name --name -n

Name of the gate.

--resource-group -g

Name of the resource group.

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 fleet gate update

Preview

Command group 'fleet gate' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates a gate. Currently only the gate state can be updated. Valid values are ('Completed').

az fleet gate update --fleet-name
                     --gate --gate-name
                     --resource-group
                     [--gate-state --gs --state]

Examples

Updates a gate.

az fleet gate update -g MyFleetResourceGroup --fleet-name MyFleetName --gate-name 3fa85f64-5717-4562-b3fc-2c963f66afa6 --state "Completed"

Required Parameters

--fleet-name -f

Name of the fleet.

--gate --gate-name -n

Name of the gate.

--resource-group -g

Name of the resource group.

Optional Parameters

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

--gate-state --gs --state

The Gate State to patch. Valid values are: Completed.

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