az workloads sap-database-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-database-instance command. Learn more about extensions.

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	GA
az workloads sap-database-instance show	Show the SAP Database Instance resource.	Extension	GA
az workloads sap-database-instance start	Starts the database instance of the SAP system.	Extension	GA
az workloads sap-database-instance stop	Stops the database instance of the SAP system.	Extension	GA
az workloads sap-database-instance update	Update the Database resource corresponding to the Virtual Instance for SAP solutions resource.This will be used by service only. PUT by end user will return a Bad Request error.	Extension	GA

az workloads sap-database-instance list

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

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

Show the SAP Database Instance resource.

az workloads sap-database-instance show [--database-instance-name --name]
                                        [--ids]
                                        [--resource-group]
                                        [--sap-virtual-instance-name --vis-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

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

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

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

Property	Value
Parameter group:	Resource Id 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

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

The name of the Virtual Instances for SAP solutions resource.

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

Starts the database instance of the SAP system.

az workloads sap-database-instance start [--database-instance-name --name]
                                         [--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 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

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

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

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

Property	Value
Parameter group:	Resource Id 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

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

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-database-instance stop

Stops the database instance of the SAP system.

az workloads sap-database-instance stop [--database-instance-name --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 --vis-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

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

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

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-database-instance update

Update the Database resource corresponding to the Virtual Instance for SAP solutions resource.This will be used by service only. PUT by end user will return a Bad Request error.

az workloads sap-database-instance update [--database-instance-name --name]
                                          [--ids]
                                          [--resource-group]
                                          [--sap-virtual-instance-name --vis-name]
                                          [--subscription]
                                          [--tags]

Optional Parameters

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

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

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

Property	Value
Parameter group:	Resource Id 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

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

The name of the Virtual Instances for SAP solutions resource.

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