Share via

az workloads sap-database-instance

  • Preview
  • Reference

Note

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

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

Manage database instance.

Commands

Name Description Type Status
az workloads sap-database-instance list

List the Database resources associated with a Virtual Instance for SAP solutions resource.

 Extension Preview
az workloads sap-database-instance show

Show the SAP Database Instance resource.

 Extension Preview
az workloads sap-database-instance start

Starts the database instance of the SAP system.

 Extension Preview
az workloads sap-database-instance stop

Stops the database instance of the SAP system.

 Extension Preview
az workloads sap-database-instance update

Update the Database resource.

 Extension Preview
az workloads sap-database-instance wait

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

 Extension Preview

az workloads sap-database-instance list

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the Database resources associated with a Virtual Instance for SAP solutions resource.

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

Examples

List workloads sap database instance

az workloads sap-database-instance list -g <resource-group-name> --vis-name <vis-name>

Required Parameters

--resource-group -g

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

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

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the SAP Database Instance resource.

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

Examples

Get an overview of the Database Instance in a Virtual instance for SAP solutions (VIS)

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

Get an overview of the Database Instance using the Azure resource ID of the App server instance

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

Optional Parameters

--database-instance-name --name -n

Database resource name string modeled as parameter for auto generation to work correctly.

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

--resource-group -g

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

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

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Starts the database instance of the SAP system.

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

Examples

Start Database instance of the SAP system. Currently start action is supported for SAP HANA Database only

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

Start Database instance of the SAP system using the Azure resource ID of the instance. Currently start action is supported for SAP HANA Database only

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

Start Database instance of the SAP system and its underlying Virtual Machine. Currently start action is supported for SAP HANA Database only

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

Optional Parameters

--database-instance-name --name -n

Database resource name string modeled as parameter for auto generation to work correctly.

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

--no-wait

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

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

--start-vm

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: False
--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 workloads sap-database-instance stop

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Stops the database instance of the SAP system.

az workloads sap-database-instance stop [--database-instance-name]
                                        [--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]
                                        [--soft-stop-timeout-seconds]
                                        [--subscription]

Examples

Stop Database instance of the SAP system: Currently stop action is supported for SAP HANA Database only.

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

Stop Database instance of the SAP system using the Azure resource ID of the instance: Currently stop action is supported for SAP HANA Database only.

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

Stop Database instance of the SAP system with Virtual Machine: Currently stop action is supported for SAP HANA Database only.

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

Soft Stop Database instance of the SAP system: Currently stop action is supported for SAP HANA Database only.

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

Optional Parameters

--database-instance-name --name -n

Database resource name string modeled as parameter for auto generation to work correctly.

--deallocate-vm

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

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

--no-wait

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

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

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

Default value: 0
--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 workloads sap-database-instance update

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the Database resource.

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

Examples

Add tags for an existing Database instance resource

az workloads sap-database-instance update --sap-virtual-instance-name <VIS name> -g <Resource-group-name> -n <ResourceName> --tags tag=test tag2=test2

Add tags for an existing Database instance resource using the Azure resource ID of the instance

az workloads sap-database-instance update --id <ResourceID> --tags tag=test1

Optional Parameters

--database-instance-name --name -n

Database resource name string modeled as parameter for auto generation to work correctly.

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

--no-wait

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

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

--subscription

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

--tags

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

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

Preview

Command group 'az workloads sap-database-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

--database-instance-name --name -n

Database resource name string modeled as parameter for auto generation to work correctly.

--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
--resource-group -g

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

--sap-virtual-instance-name --vis-name

The name of the Virtual Instances for SAP solutions resource.

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