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

Manage central instance.

Commands

Name	Description	Type	Status
az workloads sap-central-instance list	List the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.	Extension	GA
az workloads sap-central-instance show	Show the SAP Central Services Instance resource.	Extension	GA
az workloads sap-central-instance start	Starts the SAP Central Services Instance.	Extension	GA
az workloads sap-central-instance stop	Stops the SAP Central Services Instance.	Extension	GA
az workloads sap-central-instance update	Update the SAP Central Services Instance resource. This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.	Extension	GA

az workloads sap-central-instance list

List the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.

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

Examples

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

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

Show the SAP Central Services Instance resource.

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

Examples

Get an overview of a Central service Instance using the Azure resource ID of the instance

az workloads sap-central-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.

--central-instance-name --name -n

Central Services Instance 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-central-instance start

Starts the SAP Central Services Instance.

az workloads sap-central-instance start [--central-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 Central services instance of the SAP system

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

Start Central services instance of the SAP system using the Azure resource ID of the instance

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

Start Central services instance of the SAP system and its underlying Virtual Machine

az workloads sap-central-instance start --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <cs-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.

--central-instance-name --name -n

Central Services Instance 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-central-instance stop

Stops the SAP Central Services Instance.

az workloads sap-central-instance stop [--central-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]
                                       [--subscription]

Examples

Stop Central services instance of the SAP system

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

Stop Central services instance of the SAP system using the Azure resource ID of the instance

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

Stop Central services instance of the SAP system and its underlying Virtual Machine

az workloads sap-central-instance stop --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <cs-instance-name> --deallocate-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.

--central-instance-name --name -n

Central Services Instance 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

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

Update the SAP Central Services Instance resource. This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.

az workloads sap-central-instance update [--central-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.

--central-instance-name --name -n

Central Services Instance 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