Share via


az workloads sap-virtual-instance

Note

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

Manage virtual instance.

Commands

Name Description Type Status
az workloads sap-virtual-instance create

Create a Virtual Instance for SAP solutions (VIS) resource.

Extension GA
az workloads sap-virtual-instance delete

Delete a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.

Extension GA
az workloads sap-virtual-instance list

List all Virtual Instances for SAP solutions resources in a Resource Group.

Extension GA
az workloads sap-virtual-instance show

Show a Virtual Instance for SAP solutions resource.

Extension GA
az workloads sap-virtual-instance start

Starts the SAP application, that is the Central Services instance and Application server instances.

Extension GA
az workloads sap-virtual-instance stop

Stops the SAP Application, that is the Application server instances and Central Services instance.

Extension GA
az workloads sap-virtual-instance update

Update a Virtual Instance for SAP solutions (VIS) resource.

Extension GA
az workloads sap-virtual-instance wait

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

Extension GA

az workloads sap-virtual-instance create

Create a Virtual Instance for SAP solutions (VIS) resource.

az workloads sap-virtual-instance create --name --sap-virtual-instance-name
                                         --resource-group
                                         [--central-server-vm]
                                         [--configuration]
                                         [--environment {NonProd, Prod}]
                                         [--identity]
                                         [--location]
                                         [--managed-resources-network-access-type --mrg-network-access-typ {Private, Public}]
                                         [--managed-rg-name]
                                         [--managed-rg-sa-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--sap-product {ECC, Other, S4HANA}]
                                         [--tags]

Examples

Deploy infrastructure for a three-tier distributed SAP system. See sample json payload here: https://go.microsoft.com/fwlink/?linkid=2230236

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --configuration <payload-file-path> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}"

Install SAP software on the infrastructure deployed for the three-tier distributed SAP system. See sample json payload here: https://go.microsoft.com/fwlink/?linkid=2230167

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --configuration <payload-file-path> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-Identity-resource-id>:{}}}"

Deploy infrastructure for a three-tier distributed Highly Available (HA) SAP system with customized resource naming. See sample json payload here: https://go.microsoft.com/fwlink/?linkid=2230402

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --configuration <payload-file-path> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}"

Install SAP software on the infrastructure deployed for the three-tier distributed Highly Available (HA) SAP system with customized resource naming. See sample json payload here: https://go.microsoft.com/fwlink/?linkid=2230340

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --configuration <payload-file-path> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}"

Register an existing SAP system as a Virtual Instance for SAP solutions resource (VIS)

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --central-server-vm <virtual-machine-id> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}"

Register an existing SAP system as a Virtual Instance for SAP solutions resource (VIS) with a custom Managed Resource Group and Managed Storage Account Name, and specify the Managed Storage Account Network Access Type setting as per your security requirements. Learn More: https://go.microsoft.com/fwlink/?linkid=2256933

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --central-server-vm <virtual-machine-id> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}" --managed-rg-name <managed-rg-name> --managed-rg-sa-name <managed-rg-storage-account-name> --managed-resources-network-access-type <public/private>

Deploy infrastructure for a three-tier distributed Highly Available (HA) SAP system with Azure Compute Gallary Image. See sample json payload here: https://go.microsoft.com/fwlink/?linkid=2263420

az workloads sap-virtual-instance create -g <resource-group-name> -n <vis-name> --environment NonProd --sap-product s4hana --configuration <payload-file-path> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}"

Required Parameters

--name --sap-virtual-instance-name -n

The name of the Virtual Instances for SAP solutions resource.

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

--central-server-vm

The virtual machine ID or name of the Central Server.

--configuration

Path to the configuration file. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--environment

Defines the environment type - Production/Non Production.

Property Value
Parameter group: Properties Arguments
Accepted values: NonProd, Prod
--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--managed-resources-network-access-type --mrg-network-access-typ

Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228.

Property Value
Parameter group: Properties Arguments
Accepted values: Private, Public
--managed-rg-name

Managed resource group name.

Property Value
Parameter group: ManagedResourceGroupConfiguration Arguments
--managed-rg-sa-name

The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment.

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

Defines the SAP Product type.

Property Value
Parameter group: Properties Arguments
Accepted values: ECC, Other, S4HANA
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource 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 workloads sap-virtual-instance delete

Delete a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.

az workloads sap-virtual-instance delete [--ids]
                                         [--name --sap-virtual-instance-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete a Virtual Instance for SAP solutions (VIS)

az workloads sap-virtual-instance delete -g <resource-group-name> -n <vis-name>

Remove a Virtual Instance for SAP solutions (VIS) using the Azure resource ID of the VIS

az workloads sap-virtual-instance delete --id <resource-id>

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 --sap-virtual-instance-name -n

The name of the Virtual Instances for SAP solutions resource.

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
--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 workloads sap-virtual-instance list

List all Virtual Instances for SAP solutions resources in a Resource Group.

az workloads sap-virtual-instance list [--max-items]
                                       [--next-token]
                                       [--resource-group]

Examples

Get a list of the Virtual Instance(s) for SAP solutions (VIS)

az workloads sap-virtual-instance list -g <resource-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
--resource-group -g

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

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 workloads sap-virtual-instance show

Show a Virtual Instance for SAP solutions resource.

az workloads sap-virtual-instance show [--ids]
                                       [--name --sap-virtual-instance-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get an overview of any Virtual Instance(s) for SAP solutions (VIS)

az workloads sap-virtual-instance show -g <resource-group-name> -n <vis-name>

Get an overview of the Virtual Instance(s) for SAP solutions (VIS) using the Azure resource ID of the VIS

az workloads sap-virtual-instance show --id <resource-id>

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 --sap-virtual-instance-name -n

The name of the Virtual Instances for SAP solutions resource.

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 workloads sap-virtual-instance start

Starts the SAP application, that is the Central Services instance and Application server instances.

az workloads sap-virtual-instance start [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--sap-virtual-instance-name --vis-name]
                                        [--start-vm {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--subscription]

Examples

Start an SAP system: This command starts the SAP application tier, that is ASCS instance and App servers of the system.

az workloads sap-virtual-instance start -g <resource-group-name> -n <vis-name>

Start an SAP system using the Azure resource ID of the Virtual instance for SAP solutions (VIS): This command starts the SAP application tier, that is ASCS instance and App servers of the system.

az workloads sap-virtual-instance start --id <resource-id>

Start an SAP system with Virtual Machines: This command starts the SAP application tier, that is ASCS instance and App servers of the system with Virtual Machines.

az workloads sap-virtual-instance start -g <resource-group-name> -n <vis-name> --start-vm

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
--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
--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
--sap-virtual-instance-name --vis-name -n

The name of the Virtual Instances for SAP solutions resource.

Property Value
Parameter group: Resource Id Arguments
--start-vm

The boolean value indicates whether to start the virtual machines before starting the SAP instances.

Property Value
Parameter group: Body Arguments
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 workloads sap-virtual-instance stop

Stops the SAP Application, that is the Application server instances and Central Services instance.

az workloads sap-virtual-instance stop [--deallocate-vm {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--sap-virtual-instance-name --vis-name]
                                       [--soft-stop-timeout-seconds]
                                       [--subscription]

Examples

Stop an SAP system: This command stops the SAP application tier, that is ASCS instance and App servers of the system.

az workloads sap-virtual-instance stop -g <resource-group-name> -n <vis-name>

Stop an SAP system using the Azure resource ID of the Virtual instance for SAP solutions (VIS): This command stops the SAP application tier, that is ASCS instance and App servers of the system.

az workloads sap-virtual-instance stop --id <resource-id>

Stop an SAP system with Virtual Machines: This command stops the SAP application tier, that is ASCS instance and App servers of the system with Virtual Machines.

az workloads sap-virtual-instance stop -g <resource-group-name> -n <vis-name> --deallocate-vm

Soft Stop an SAP system: This command soft stops the SAP application tier, that is ASCS instance and App servers of the system.

az workloads sap-virtual-instance stop -g <resource-group-name> -n <vis-name> --soft-stop-timeout-seconds <timeout-in-seconds>

Optional Parameters

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

--deallocate-vm

The boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances.

Property Value
Parameter group: Body Arguments
Default value: False
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.

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
--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
--sap-virtual-instance-name --vis-name -n

The name of the Virtual Instances for SAP solutions resource.

Property Value
Parameter group: Resource Id Arguments
--soft-stop-timeout-seconds

This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. hard stop.

Property Value
Parameter group: Body Arguments
Default value: 0
--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 workloads sap-virtual-instance update

Update a Virtual Instance for SAP solutions (VIS) resource.

az workloads sap-virtual-instance update [--identity]
                                         [--ids]
                                         [--managed-resources-network-access-type --mrg-network-access-typ {Private, Public}]
                                         [--name --sap-virtual-instance-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--tags]

Examples

Add tags for an existing Virtual Instance for SAP solutions (VIS) resource

az workloads sap-virtual-instance update -g <resource-group-name> -n <vis-name> --tags tag1=test1 tag2=test2

Add tags for an existing Virtual Instance for SAP solutions (VIS) resource using the Azure resource ID of the VIS

az workloads sap-virtual-instance update --id <resource-id> --tags tag1=test1

Add/Change Identity and Managed Resource Network Access for an existing Virtual Instance for SAP Solutions (VIS) resource

az workloads sap-virtual-instance update -g <resource-group-name> -n <vis-name> --identity "{type:UserAssigned,userAssignedIdentities:{<managed-identity-resource-id>:{}}}" --managed-resources-network-access-type <public/private>

Optional Parameters

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

--identity

Managed service identity (user assigned identities) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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
--managed-resources-network-access-type --mrg-network-access-typ

Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228.

Property Value
Parameter group: Properties Arguments
Default value: Public
Accepted values: Private, Public
--name --sap-virtual-instance-name -n

The name of the Virtual Instances for SAP solutions resource.

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

Gets or sets the Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 workloads sap-virtual-instance wait

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

az workloads sap-virtual-instance wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name --sap-virtual-instance-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

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 --sap-virtual-instance-name -n

The name of the Virtual Instances for SAP solutions resource.

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