az workloads sap-virtual-instance
Note
This reference is part of the workloads extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az workloads sap-virtual-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 virtual instance.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az workloads sap-virtual-instance create |
Create a Virtual Instance for SAP solutions (VIS) resource. |
Extension | Preview |
| 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 | Preview |
| az workloads sap-virtual-instance list |
List all Virtual Instances for SAP solutions resources in a Resource Group. |
Extension | Preview |
| az workloads sap-virtual-instance show |
Show a Virtual Instance for SAP solutions resource. |
Extension | Preview |
| az workloads sap-virtual-instance start |
Starts the SAP application, that is the Central Services instance and Application server instances. |
Extension | Preview |
| az workloads sap-virtual-instance stop |
Stops the SAP Application, that is the Application server instances and Central Services instance. |
Extension | Preview |
| az workloads sap-virtual-instance update |
Update a Virtual Instance for SAP solutions (VIS) resource. |
Extension | Preview |
| az workloads sap-virtual-instance wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az workloads sap-virtual-instance create
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a Virtual Instance for SAP solutions (VIS) resource.
az workloads sap-virtual-instance create --name
--resource-group
[--central-server-vm]
[--configuration]
[--environment {NonProd, Prod}]
[--identity]
[--location]
[--managed-resources-network-access-type {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
The name of the Virtual Instances for SAP solutions resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The virtual machine ID or name of the Central Server.
Path to the configuration file. Support json-file and yaml-file.
Defines the environment type - Production/Non Production.
A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives.
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.
Managed resource group 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.
Do not wait for the long-running operation to finish.
Defines the SAP Product type.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance delete
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--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
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.
The name of the Virtual Instances for SAP solutions resource.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance list
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all Virtual Instances for SAP solutions resources in a Resource Group.
az workloads sap-virtual-instance list --resource-group
[--max-items]
[--next-token]Examples
Get a list of the Virtual Instance(s) for SAP solutions (VIS)
az workloads sap-virtual-instance list -g <resource-group-name>Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance show
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show a Virtual Instance for SAP solutions resource.
az workloads sap-virtual-instance show [--ids]
[--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
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.
The name of the Virtual Instances for SAP solutions resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance start
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--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-vmOptional Parameters
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Virtual Instances for SAP solutions resource.
The boolean value indicates whether to start the virtual machines before starting the SAP instances.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance stop
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--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-vmSoft 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 boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Virtual Instances for SAP solutions resource.
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance update
Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a Virtual Instance for SAP solutions (VIS) resource.
az workloads sap-virtual-instance update [--add]
[--configuration]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--managed-resource-group-configuration]
[--managed-resources-network-access-type {Private, Public}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--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=test2Add 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=test1Add/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
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Managed service identity (user assigned identities) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Managed resource group configuration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
The name of the Virtual Instances for SAP solutions resource.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az workloads sap-virtual-instance wait
Command group 'az workloads' 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-virtual-instance wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the Virtual Instances for SAP solutions resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for