az workloads

Note

This reference is part of the workloads extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az workloads command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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	Preview
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-availability-zone-detail	Show the recommended SAP Availability Zone Pair Details for your region.	Extension	Preview
az workloads sap-central-instance	Manage central instance.	Extension	Preview
az workloads sap-central-instance list	List the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.	Extension	Preview
az workloads sap-central-instance show	Show the SAP Central Services Instance resource.	Extension	Preview
az workloads sap-central-instance start	Starts the SAP Central Services Instance.	Extension	Preview
az workloads sap-central-instance stop	Stops the SAP Central Services Instance.	Extension	Preview
az workloads sap-central-instance update	Update the SAP Central Services Instance resource. This can be used to update tags on the resource.	Extension	Preview
az workloads sap-central-instance wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az workloads sap-database-instance	Manage database instance.	Extension	Preview
az workloads sap-database-instance list	List the Database resources associated with a Virtual Instance for SAP solutions resource.	Extension	Preview
az workloads sap-database-instance show	Show the SAP Database Instance resource.	Extension	Preview
az workloads sap-database-instance start	Starts the database instance of the SAP system.	Extension	Preview
az workloads sap-database-instance stop	Stops the database instance of the SAP system.	Extension	Preview
az workloads sap-database-instance update	Update the Database resource.	Extension	Preview
az workloads sap-database-instance wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az workloads sap-disk-configuration	Show the SAP Disk Configuration Layout prod/non-prod SAP System.	Extension	Preview
az workloads sap-sizing-recommendation	Show SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier.	Extension	Preview
az workloads sap-supported-sku	Show a list of SAP supported SKUs for ASCS, Application and Database tier.	Extension	Preview
az workloads sap-virtual-instance	Manage virtual instance.	Extension	Preview
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-availability-zone-detail

Preview

Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the recommended SAP Availability Zone Pair Details for your region.

az workloads sap-availability-zone-detail [--app-location]
                                          [--database-type {DB2, HANA}]
                                          [--ids]
                                          [--location]
                                          [--sap-product {ECC, Other, S4HANA}]
                                          [--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"

Optional Parameters

--app-location

The geo-location where the SAP resources will be created.

--database-type

The database type. Eg: HANA, DB2, etc.

Accepted values: DB2, HANA

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sap-product

Defines the SAP Product type.

Accepted values: ECC, Other, S4HANA

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az workloads sap-disk-configuration

Preview

Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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}]
                                    [--ids]
                                    [--location]
                                    [--sap-product {ECC, Other, S4HANA}]
                                    [--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

Optional Parameters

--app-location

The geo-location where the SAP resources will be created.

--database-type

The database type. Eg: HANA, DB2, etc.

Accepted values: DB2, HANA

--db-vm-sku

The VM SKU for database instance.

--deployment-type

The deployment type. Eg: SingleServer/ThreeTier.

Accepted values: SingleServer, ThreeTier

--environment

Defines the environment type - Production/Non Production.

Accepted values: NonProd, Prod

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sap-product

Defines the SAP Product type.

Accepted values: ECC, Other, S4HANA

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az workloads sap-sizing-recommendation

Preview

Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]
                                       [--db-scale-method {ScaleUp}]
                                       [--deployment-type {SingleServer, ThreeTier}]
                                       [--environment {NonProd, Prod}]
                                       [--high-availability-type {AvailabilitySet, AvailabilityZone}]
                                       [--ids]
                                       [--location]
                                       [--sap-product {ECC, Other, S4HANA}]
                                       [--saps]
                                       [--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

Optional Parameters

--app-location

The geo-location where the resource is to be created.

--database-type

The database type.

Accepted values: DB2, HANA

--db-memory

The database memory configuration.

--db-scale-method

The DB scale method.

Accepted values: ScaleUp

--deployment-type

The deployment type. Eg: SingleServer/ThreeTier.

Accepted values: SingleServer, ThreeTier

--environment

Defines the environment type - Production/Non Production.

Accepted values: NonProd, Prod

--high-availability-type

The high availability type.

Accepted values: AvailabilitySet, AvailabilityZone

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sap-product

Defines the SAP Product type.

Accepted values: ECC, Other, S4HANA

--saps

The SAP Application Performance Standard measurement.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az workloads sap-supported-sku

Preview

Command group 'az workloads' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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}]
                               [--high-availability-type {AvailabilitySet, AvailabilityZone}]
                               [--ids]
                               [--location]
                               [--sap-product {ECC, Other, S4HANA}]
                               [--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"

Optional Parameters

--app-location

The geo-location where the resource is to be created.

--database-type

The database type. Eg: HANA, DB2, etc.

Accepted values: DB2, HANA

--deployment-type

The deployment type. Eg: SingleServer/ThreeTier.

Accepted values: SingleServer, ThreeTier

--environment

Defines the environment type - Production/Non Production.

Accepted values: NonProd, Prod

--high-availability-type

The high availability type.

Accepted values: AvailabilitySet, AvailabilityZone

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sap-product

Defines the SAP Product type.

Accepted values: ECC, Other, S4HANA

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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