az workloads sap-application-server-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-application-server-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 application instance.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az workloads sap-application-server-instance list |
List the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource. |
Extension | Preview |
| az workloads sap-application-server-instance show |
Show the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. |
Extension | Preview |
| az workloads sap-application-server-instance start |
Starts the SAP Application Server Instance. |
Extension | Preview |
| az workloads sap-application-server-instance stop |
Stops the SAP Application Server Instance. |
Extension | Preview |
| az workloads sap-application-server-instance update |
Update the SAP Application Server Instance resource. |
Extension | Preview |
| az workloads sap-application-server-instance wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az workloads sap-application-server-instance list
Command group 'az workloads sap-application-server-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.
az workloads sap-application-server-instance list --resource-group
--sap-virtual-instance-name
[--max-items]
[--next-token]Examples
Get an overview of The App Server Instances in a Virtual instance for SAP solutions (VIS)
az workloads sap-application-server-instance list -g <resource-group-name> --sap-virtual-instance-name <vis-name>Required Parameters
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.
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-application-server-instance show
Command group 'az workloads sap-application-server-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.
az workloads sap-application-server-instance show [--application-instance-name]
[--ids]
[--resource-group]
[--sap-virtual-instance-name]
[--subscription]Examples
Get an overview of an App Server Instance
az workloads sap-application-server-instance show -g <resource-group-name> --sap-virtual-instance-name <vis-name> -n <app-instance-name>Get an overview of an App Server Instance using the Azure resource ID of the instance
az workloads sap-application-server-instance show --id <resource-id>Optional Parameters
The name of SAP Application Server instance resource.
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.
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.
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-application-server-instance start
Command group 'az workloads sap-application-server-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Starts the SAP Application Server Instance.
az workloads sap-application-server-instance start [--application-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 an Application server instance of the SAP system
az workloads sap-application-server-instance start --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <app-instance-name>Start an Application server instance of the SAP system using the Azure resource ID of the instance
az workloads sap-application-server-instance start --id <resource-id>Start an Application server instance of the SAP system and its underlying Virtual Machine
az workloads sap-application-server-instance start --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <app-instance-name> --start-vmOptional Parameters
The name of SAP Application Server instance resource.
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-application-server-instance stop
Command group 'az workloads sap-application-server-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Stops the SAP Application Server Instance.
az workloads sap-application-server-instance stop [--application-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 Application server instance of the SAP system
az workloads sap-application-server-instance stop --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <app-instance-name>Stop Application server instance of the SAP system using the Azure resource ID of the instance
az workloads sap-application-server-instance stop --id <resource-id>Stop Application server instance of the SAP system and its underlying Virtual Machine
az workloads sap-application-server-instance stop --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <app-instance-name> --deallocate-vmSoft Stop Application server instance of the SAP system
az workloads sap-application-server-instance stop --sap-virtual-instance-name <vis-name> -g <resource-group-name> -n <app-instance-name> --soft-stop-timeout-seconds <timeout-in-seconds>Optional Parameters
The name of SAP Application Server instance resource.
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-application-server-instance update
Command group 'az workloads sap-application-server-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update the SAP Application Server Instance resource.
az workloads sap-application-server-instance update [--application-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 App server instance resource
az workloads sap-application-server-instance update --sap-virtual-instance-name <VIS name> -g <Resource-group-name> -n <ResourceName> --tags tag=test tag2=test2Add tags for an existing App server instance resource using the Azure resource ID of the instance
az workloads sap-application-server-instance update --id <ResourceID> --tags tag=test1Optional Parameters
The name of SAP Application Server instance resource.
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Gets or sets the 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-application-server-instance wait
Command group 'az workloads sap-application-server-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-application-server-instance wait [--application-instance-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--sap-virtual-instance-name]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of SAP Application Server instance resource.
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.
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.
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