az workloads
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 command. Learn more about extensions.
Manage workloads.
Commands
Name | Description | Type | Status |
---|---|---|---|
az workloads monitor |
Manage workloads monitor. |
Extension | Preview |
az workloads monitor create |
Create a SAP monitor for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor delete |
Delete a SAP monitor with the specified subscription, resource group, and SAP monitor name. |
Extension | Preview |
az workloads monitor list |
List a list of SAP monitors in the specified resource group. |
Extension | Preview |
az workloads monitor provider-instance |
Manage monitor provider instance. |
Extension | Preview |
az workloads monitor provider-instance create |
Create a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. |
Extension | Preview |
az workloads monitor provider-instance delete |
Delete a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. |
Extension | Preview |
az workloads monitor provider-instance list |
List a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances. |
Extension | Preview |
az workloads monitor provider-instance show |
Show properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. |
Extension | Preview |
az workloads monitor provider-instance wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az workloads monitor sap-landscape-monitor |
Manage monitor sap landscape monitor. |
Extension | Preview |
az workloads monitor sap-landscape-monitor create |
Create a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor sap-landscape-monitor delete |
Delete a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name. |
Extension | Preview |
az workloads monitor sap-landscape-monitor list |
List configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor sap-landscape-monitor show |
Show configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor sap-landscape-monitor update |
Update a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor show |
Show properties of a SAP monitor for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor update |
Update a SAP monitor for the specified subscription, resource group, and resource name. |
Extension | Preview |
az workloads monitor wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az workloads sap-application-server-instance |
Manage application instance. |
Extension | GA |
az workloads sap-application-server-instance list |
List the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource. |
Extension | GA |
az workloads sap-application-server-instance show |
Show the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. |
Extension | GA |
az workloads sap-application-server-instance start |
Starts the SAP Application Server Instance. |
Extension | GA |
az workloads sap-application-server-instance stop |
Stops the SAP Application Server Instance. |
Extension | GA |
az workloads sap-application-server-instance update |
Update the SAP Application Server Instance resource. This will be used by service only. PUT by end user will return a Bad Request error. |
Extension | GA |
az workloads sap-availability-zone-detail |
Show the recommended SAP Availability Zone Pair Details for your region. |
Extension | GA |
az workloads sap-central-instance |
Manage central instance. |
Extension | GA |
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-database-instance |
Manage database instance. |
Extension | GA |
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-disk-configuration |
Show the SAP Disk Configuration Layout prod/non-prod SAP System. |
Extension | GA |
az workloads sap-sizing-recommendation |
Show SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier. |
Extension | GA |
az workloads sap-supported-sku |
Show a list of SAP supported SKUs for ASCS, Application and Database tier. |
Extension | GA |
az workloads sap-virtual-instance |
Manage virtual instance. |
Extension | GA |
az workloads sap-virtual-instance create |
Create a Virtual Instance for SAP solutions (VIS) resource. |
Extension | GA |
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 | GA |
az workloads sap-virtual-instance list |
List all Virtual Instances for SAP solutions resources in a Resource Group. |
Extension | GA |
az workloads sap-virtual-instance show |
Show a Virtual Instance for SAP solutions resource. |
Extension | GA |
az workloads sap-virtual-instance start |
Starts the SAP application, that is the Central Services instance and Application server instances. |
Extension | GA |
az workloads sap-virtual-instance stop |
Stops the SAP Application, that is the Application server instances and Central Services instance. |
Extension | GA |
az workloads sap-virtual-instance update |
Update a Virtual Instance for SAP solutions (VIS) resource. |
Extension | GA |
az workloads sap-virtual-instance wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az workloads sap-availability-zone-detail
Show the recommended SAP Availability Zone Pair Details for your region.
az workloads sap-availability-zone-detail --app-location
--database-type {DB2, HANA}
--sap-product {ECC, Other, S4HANA}
[--ids]
[--location]
[--subscription]
Examples
Show the sap availability zone detail
az workloads sap-availability-zone-detail --app-location "northeurope" --database-type "HANA" --sap-product "S4HANA" --location "northeurope"
Required Parameters
The geo-location where the SAP resources will be created.
Property | Value |
---|---|
Parameter group: | Body Arguments |
The database type. Eg: HANA, DB2, etc.
Property | Value |
---|---|
Parameter group: | Body Arguments |
Accepted values: | DB2, HANA |
Defines the SAP Product type.
Property | Value |
---|---|
Parameter group: | Body Arguments |
Accepted values: | ECC, Other, S4HANA |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az workloads sap-disk-configuration
Show the SAP Disk Configuration Layout prod/non-prod SAP System.
az workloads sap-disk-configuration --app-location
--database-type {DB2, HANA}
--db-vm-sku
--deployment-type {SingleServer, ThreeTier}
--environment {NonProd, Prod}
--sap-product {ECC, Other, S4HANA}
[--ids]
[--location]
[--subscription]
Examples
Get the SAP Disk Configuration Layout for prod/non-prod SAP System
az workloads sap-disk-configuration --app-location eastus --database-type HANA --db-vm-sku Standard_M32ts --deployment-type SingleServer --environment NonProd --sap-product S4HANA --location eastus
Required Parameters
The geo-location where the SAP resources will be created.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
The database type. Eg: HANA, DB2, etc.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
Accepted values: | DB2, HANA |
The VM SKU for database instance.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
The deployment type. Eg: SingleServer/ThreeTier.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
Accepted values: | SingleServer, ThreeTier |
Defines the environment type - Production/Non Production.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
Accepted values: | NonProd, Prod |
Defines the SAP Product type.
Property | Value |
---|---|
Parameter group: | SAPDiskConfigurations Arguments |
Accepted values: | ECC, Other, S4HANA |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az workloads sap-sizing-recommendation
Show SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier.
az workloads sap-sizing-recommendation --app-location
--database-type {DB2, HANA}
--db-memory
--deployment-type {SingleServer, ThreeTier}
--environment {NonProd, Prod}
--sap-product {ECC, Other, S4HANA}
--saps
[--db-scale-method {ScaleUp}]
[--high-availability-type {AvailabilitySet, AvailabilityZone}]
[--ids]
[--location]
[--subscription]
Examples
Get sizing recommendations for a Distributed with High Availability (HA) system by providing SAPS for application tier and memory required for database tier of the SAP system
az workloads sap-sizing-recommendation --app-location "eastus" --database-type "HANA" --db-memory 1024 --deployment-type "ThreeTier" --environment "Prod" --high-availability-type "AvailabilitySet" --sap-product "S4HANA" --saps 75000 --location "eastus2" --db-scale-method ScaleUp
Get sizing recommendations for a Distributed system by providing SAPS for application tier and memory required for database tier of the SAP system
az workloads sap-sizing-recommendation --app-location "eastus" --database-type "HANA" --db-memory 1024 --deployment-type "ThreeTier" --environment "Prod" --sap-product "S4HANA" --saps 20000 --location "northeurope" --db-scale-method ScaleUp
Required Parameters
The geo-location where the resource is to be created.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
The database type.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | DB2, HANA |
The database memory configuration.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
The deployment type. Eg: SingleServer/ThreeTier.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | SingleServer, ThreeTier |
Defines the environment type - Production/Non Production.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | NonProd, Prod |
Defines the SAP Product type.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | ECC, Other, S4HANA |
The SAP Application Performance Standard measurement.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The DB scale method.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | ScaleUp |
The high availability type.
Property | Value |
---|---|
Parameter group: | SAPSizingRecommendation Arguments |
Accepted values: | AvailabilitySet, AvailabilityZone |
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az workloads sap-supported-sku
Show a list of SAP supported SKUs for ASCS, Application and Database tier.
az workloads sap-supported-sku --app-location
--database-type {DB2, HANA}
--deployment-type {SingleServer, ThreeTier}
--environment {NonProd, Prod}
--sap-product {ECC, Other, S4HANA}
[--high-availability-type {AvailabilitySet, AvailabilityZone}]
[--ids]
[--location]
[--subscription]
Examples
Get a list of SKUs supported for your SAP system deployment type from Azure Center for SAP solutions
az workloads sap-supported-sku --app-location "eastus" --database-type "HANA" --deployment-type "ThreeTier" --environment "Prod" --high-availability-type "AvailabilitySet" --sap-product "S4HANA" --location "eastus"
Required Parameters
The geo-location where the resource is to be created.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
The database type. Eg: HANA, DB2, etc.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
Accepted values: | DB2, HANA |
The deployment type. Eg: SingleServer/ThreeTier.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
Accepted values: | SingleServer, ThreeTier |
Defines the environment type - Production/Non Production.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
Accepted values: | NonProd, Prod |
Defines the SAP Product type.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
Accepted values: | ECC, Other, S4HANA |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The high availability type.
Property | Value |
---|---|
Parameter group: | SAPSupportedSku Arguments |
Accepted values: | AvailabilitySet, AvailabilityZone |
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |