@azure/arm-workloads package
Classes
WorkloadsClient |
Interfaces
ApplicationServerConfiguration |
Gets or sets the application server configuration. |
ApplicationServerFullResourceNames |
The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer. |
ApplicationServerVmDetails |
The Application Server VM Details. |
CentralServerConfiguration |
Gets or sets the central server configuration. |
CentralServerFullResourceNames |
The full resource names object for central server layer resources. |
CentralServerVmDetails |
The SAP Central Services Instance VM details. |
CreateAndMountFileShareConfiguration |
Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow. Please pre-create the resource group you intend to place the transport directory in. The storage account and fileshare will be auto-created by the ACSS and doesn’t need to pre-created. |
DB2ProviderInstanceProperties |
Gets or sets the DB2 provider properties. |
DatabaseConfiguration |
Gets or sets the database configuration. |
DatabaseServerFullResourceNames |
The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer. |
DatabaseVmDetails |
Database VM details. |
DeployerVmPackages |
Defines the url and storage account ID where deployer VM packages are uploaded |
DeploymentConfiguration |
Deployment Configuration. |
DeploymentWithOSConfiguration |
Deployment along with OS Configuration. |
DiscoveryConfiguration |
Discovery Details. |
DiskConfiguration |
The Disk Configuration Details. |
DiskDetails |
The supported disk size details for a disk type. |
DiskSku |
The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS. |
DiskVolumeConfiguration |
The disk configuration required for the selected volume. |
EnqueueReplicationServerProperties |
Defines the SAP Enqueue Replication Server (ERS) properties. |
EnqueueServerProperties |
Defines the SAP Enqueue Server properties. |
ErrorAdditionalInfo |
The resource management error additional info. |
ErrorDefinition |
Error definition. |
ErrorDetail |
The error detail. |
ErrorInnerError |
Object containing more specific information than the current object about the error. |
ErrorModel |
Standard error object. |
ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
ExternalInstallationSoftwareConfiguration |
The SAP Software configuration Input when the software is installed externally outside the service. |
FileShareConfiguration |
File Share configuration details, populated with information on storage configuration mounted on the VIS. The createAndMount option is selected in case of missing input. |
GatewayServerProperties |
Defines the SAP Gateway Server properties. |
HanaDbProviderInstanceProperties |
Gets or sets the provider properties. |
HighAvailabilityConfiguration |
Gets or sets the high availability configuration. |
HighAvailabilitySoftwareConfiguration |
Gets or sets the HA software configuration. |
ImageReference |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. |
InfrastructureConfiguration |
Deploy SAP Infrastructure Details. |
LinuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. |
LoadBalancerDetails |
The Load Balancer details such as Load Balancer ID. |
LoadBalancerResourceNames |
The resource names object for load balancer and related resources. |
ManagedRGConfiguration |
Managed resource group configuration |
MessageServerProperties |
Defines the SAP Message Server properties. |
Monitor |
SAP monitor info on Azure (ARM properties and SAP monitor properties) |
MonitorListResult |
The response from the List SAP monitors operation. |
MonitorPropertiesErrors |
Defines the SAP monitor errors. |
Monitors |
Interface representing a Monitors. |
MonitorsCreateOptionalParams |
Optional parameters. |
MonitorsDeleteOptionalParams |
Optional parameters. |
MonitorsGetOptionalParams |
Optional parameters. |
MonitorsListByResourceGroupNextOptionalParams |
Optional parameters. |
MonitorsListByResourceGroupOptionalParams |
Optional parameters. |
MonitorsListNextOptionalParams |
Optional parameters. |
MonitorsListOptionalParams |
Optional parameters. |
MonitorsUpdateOptionalParams |
Optional parameters. |
MountFileShareConfiguration |
Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow. |
MsSqlServerProviderInstanceProperties |
Gets or sets the SQL server provider properties. |
NetworkConfiguration |
Defines the network configuration type for SAP system infrastructure that is being deployed |
NetworkInterfaceResourceNames |
The resource names object for network interface and related resources. |
OSConfiguration |
Defines the OS configuration. |
OSProfile |
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
OperationDisplay |
Localized display information for this particular operation. |
OperationListResult |
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. |
OperationStatusResult |
The current status of an async operation. |
Operations |
Interface representing a Operations. |
OperationsContent |
Defines the workload operation content. |
OperationsDefinition |
Properties of an Operation. |
OperationsDefinitionArrayResponseWithContinuation |
Defines the workload operation definition response. |
OperationsDefinitionDisplay |
Display information of the operation. |
OperationsDisplayDefinition |
Defines the workload operation. |
OperationsListNextOptionalParams |
Optional parameters. |
OperationsListOptionalParams |
Optional parameters. |
OsSapConfiguration |
Defines the OS and SAP Configurations for Deployment |
PrometheusHaClusterProviderInstanceProperties |
Gets or sets the PrometheusHaCluster provider properties. |
PrometheusOSProviderInstanceProperties |
Gets or sets the PrometheusOS provider properties. |
ProviderInstance |
A provider instance associated with SAP monitor. |
ProviderInstanceListResult |
The response from the List provider instances operation. |
ProviderInstancePropertiesErrors |
Defines the provider instance errors. |
ProviderInstances |
Interface representing a ProviderInstances. |
ProviderInstancesCreateOptionalParams |
Optional parameters. |
ProviderInstancesDeleteOptionalParams |
Optional parameters. |
ProviderInstancesGetOptionalParams |
Optional parameters. |
ProviderInstancesListNextOptionalParams |
Optional parameters. |
ProviderInstancesListOptionalParams |
Optional parameters. |
ProviderSpecificProperties |
Gets or sets the provider specific properties. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
SAPApplicationServerInstance |
Define the SAP Application Server Instance resource. |
SAPApplicationServerInstanceList |
Defines the collection of SAP Application Server Instance resources. |
SAPApplicationServerInstances |
Interface representing a SAPApplicationServerInstances. |
SAPApplicationServerInstancesCreateOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesDeleteOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesGetOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesListNextOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesListOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesStartInstanceOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesStopInstanceOptionalParams |
Optional parameters. |
SAPApplicationServerInstancesUpdateOptionalParams |
Optional parameters. |
SAPAvailabilityZoneDetailsOptionalParams |
Optional parameters. |
SAPAvailabilityZoneDetailsRequest |
The SAP request to get list of availability zones. |
SAPAvailabilityZoneDetailsResult |
The list of supported availability zone pairs which are part of SAP HA deployment. |
SAPAvailabilityZonePair |
The SAP Availability Zone Pair. |
SAPCentralInstanceList |
Defines the collection of SAP Central Services Instance resources. |
SAPCentralInstances |
Interface representing a SAPCentralInstances. |
SAPCentralInstancesCreateOptionalParams |
Optional parameters. |
SAPCentralInstancesDeleteOptionalParams |
Optional parameters. |
SAPCentralInstancesGetOptionalParams |
Optional parameters. |
SAPCentralInstancesListNextOptionalParams |
Optional parameters. |
SAPCentralInstancesListOptionalParams |
Optional parameters. |
SAPCentralInstancesStartInstanceOptionalParams |
Optional parameters. |
SAPCentralInstancesStopInstanceOptionalParams |
Optional parameters. |
SAPCentralInstancesUpdateOptionalParams |
Optional parameters. |
SAPCentralServerInstance |
Define the SAP Central Services Instance resource. |
SAPConfiguration |
The SAP Configuration. |
SAPDatabaseInstance |
Define the Database resource. |
SAPDatabaseInstanceList |
Defines the collection of SAP Database Instances. |
SAPDatabaseInstances |
Interface representing a SAPDatabaseInstances. |
SAPDatabaseInstancesCreateOptionalParams |
Optional parameters. |
SAPDatabaseInstancesDeleteOptionalParams |
Optional parameters. |
SAPDatabaseInstancesGetOptionalParams |
Optional parameters. |
SAPDatabaseInstancesListNextOptionalParams |
Optional parameters. |
SAPDatabaseInstancesListOptionalParams |
Optional parameters. |
SAPDatabaseInstancesStartInstanceOptionalParams |
Optional parameters. |
SAPDatabaseInstancesStopInstanceOptionalParams |
Optional parameters. |
SAPDatabaseInstancesUpdateOptionalParams |
Optional parameters. |
SAPDiskConfiguration |
The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type. |
SAPDiskConfigurationsOptionalParams |
Optional parameters. |
SAPDiskConfigurationsRequest |
The SAP request to get list of disk configurations. |
SAPDiskConfigurationsResult |
The list of disk configuration for vmSku which are part of SAP deployment. |
SAPInstallWithoutOSConfigSoftwareConfiguration |
The SAP Software configuration Input when the software is to be installed by service without OS Configurations |
SAPSizingRecommendationRequest |
The SAP Sizing Recommendation request. |
SAPSizingRecommendationResult |
The SAP sizing recommendation result. |
SAPSizingRecommendationsOptionalParams |
Optional parameters. |
SAPSupportedResourceSkusResult |
The list of supported SKUs for different resources which are part of SAP deployment. |
SAPSupportedSku |
The SAP supported SKU. |
SAPSupportedSkuOptionalParams |
Optional parameters. |
SAPSupportedSkusRequest |
The SAP request to get list of supported SKUs. |
SAPVirtualInstance |
Define the Virtual Instance for SAP solutions resource. |
SAPVirtualInstanceError |
An error response from the Virtual Instance for SAP Workload service. |
SAPVirtualInstanceList |
Defines the collection of Virtual Instance for SAP solutions resources. |
SAPVirtualInstances |
Interface representing a SAPVirtualInstances. |
SAPVirtualInstancesCreateOptionalParams |
Optional parameters. |
SAPVirtualInstancesDeleteOptionalParams |
Optional parameters. |
SAPVirtualInstancesGetOptionalParams |
Optional parameters. |
SAPVirtualInstancesListByResourceGroupNextOptionalParams |
Optional parameters. |
SAPVirtualInstancesListByResourceGroupOptionalParams |
Optional parameters. |
SAPVirtualInstancesListBySubscriptionNextOptionalParams |
Optional parameters. |
SAPVirtualInstancesListBySubscriptionOptionalParams |
Optional parameters. |
SAPVirtualInstancesStartOptionalParams |
Optional parameters. |
SAPVirtualInstancesStopOptionalParams |
Optional parameters. |
SAPVirtualInstancesUpdateOptionalParams |
Optional parameters. |
SapLandscapeMonitor |
configuration associated with SAP Landscape Monitor Dashboard. |
SapLandscapeMonitorCreateOptionalParams |
Optional parameters. |
SapLandscapeMonitorDeleteOptionalParams |
Optional parameters. |
SapLandscapeMonitorGetOptionalParams |
Optional parameters. |
SapLandscapeMonitorListOptionalParams |
Optional parameters. |
SapLandscapeMonitorListResult |
The response from the List SAP Landscape Monitor Dashboard operation. |
SapLandscapeMonitorMetricThresholds |
Gets or sets the Threshold Values for Top Metrics Health. |
SapLandscapeMonitorOperations |
Interface representing a SapLandscapeMonitorOperations. |
SapLandscapeMonitorPropertiesGrouping |
Gets or sets the SID groupings by landscape and Environment. |
SapLandscapeMonitorSidMapping |
Gets or sets the mapping for SID to Environment/Applications. |
SapLandscapeMonitorUpdateOptionalParams |
Optional parameters. |
SapNetWeaverProviderInstanceProperties |
Gets or sets the provider properties. |
ServiceInitiatedSoftwareConfiguration |
The SAP Software configuration Input when the software is to be installed by service. |
SharedStorageResourceNames |
The resource names object for shared storage. |
SingleServerConfiguration |
Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see here |
SingleServerCustomResourceNames |
The resource-names input to specify custom names for underlying azure resources that are part of a single server SAP system. |
SingleServerFullResourceNames |
The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system. |
SingleServerRecommendationResult |
The recommended configuration for a single server SAP system. |
SkipFileShareConfiguration |
Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required. |
SoftwareConfiguration |
The SAP Software configuration Input. |
SshConfiguration |
SSH configuration for Linux based VMs running on Azure |
SshKeyPair |
The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format. |
SshPublicKey |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
StopRequest |
Stop SAP instance(s) request body. |
StorageConfiguration |
Gets or sets the storage configuration. |
StorageInformation |
Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
Tags |
Tags field of the resource. |
ThreeTierConfiguration |
Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see here |
ThreeTierCustomResourceNames |
The resource-names input to specify custom names for underlying azure resources that are part of a three tier SAP system. |
ThreeTierFullResourceNames |
The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system. |
ThreeTierRecommendationResult |
The recommended configuration for a three tier SAP system. |
TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
UpdateMonitorRequest |
Defines the request body for updating SAP monitor resource. |
UpdateSAPApplicationInstanceRequest |
Defines the request body for updating SAP Application Instance. |
UpdateSAPCentralInstanceRequest |
Defines the request body for updating SAP Central Instance. |
UpdateSAPDatabaseInstanceRequest |
Defines the request body for updating SAP Database Instance. |
UpdateSAPVirtualInstanceRequest |
Defines the request body for updating Virtual Instance for SAP. |
UserAssignedIdentity |
User assigned identity properties |
UserAssignedServiceIdentity |
A pre-created user assigned identity with appropriate roles assigned. To learn more on identity and roles required, visit the ACSS how-to-guide. |
VirtualMachineConfiguration |
Defines the virtual machine configuration. |
VirtualMachineResourceNames |
The resource names object for virtual machine and related resources. |
WindowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
WorkloadsClientOptionalParams |
Optional parameters. |
Type Aliases
ActionType |
Defines values for ActionType. Known values supported by the serviceInternal |
ApplicationServerVirtualMachineType |
Defines values for ApplicationServerVirtualMachineType. Known values supported by the serviceActive |
CentralServerVirtualMachineType |
Defines values for CentralServerVirtualMachineType. Known values supported by the servicePrimary |
ConfigurationType |
Defines values for ConfigurationType. Known values supported by the serviceSkip |
CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
DiskSkuName |
Defines values for DiskSkuName. Known values supported by the serviceStandard_LRS |
EnqueueReplicationServerType |
Defines values for EnqueueReplicationServerType. Known values supported by the serviceEnqueueReplicator1 |
FileShareConfigurationUnion | |
InfrastructureConfigurationUnion | |
ManagedServiceIdentityType |
Defines values for ManagedServiceIdentityType. Known values supported by the serviceNone |
MonitorsCreateResponse |
Contains response data for the create operation. |
MonitorsDeleteResponse |
Contains response data for the delete operation. |
MonitorsGetResponse |
Contains response data for the get operation. |
MonitorsListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
MonitorsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
MonitorsListNextResponse |
Contains response data for the listNext operation. |
MonitorsListResponse |
Contains response data for the list operation. |
MonitorsUpdateResponse |
Contains response data for the update operation. |
NamingPatternType |
Defines values for NamingPatternType. Known values supported by the serviceFullResourceName |
OSConfigurationUnion | |
OSType |
Defines values for OSType. Known values supported by the serviceLinux |
OperationProperties |
Defines values for OperationProperties. Known values supported by the serviceNotSpecified |
OperationsListNextResponse |
Contains response data for the listNext operation. |
OperationsListResponse |
Contains response data for the list operation. |
Origin |
Defines values for Origin. Known values supported by the serviceuser |
ProviderInstancesCreateResponse |
Contains response data for the create operation. |
ProviderInstancesDeleteResponse |
Contains response data for the delete operation. |
ProviderInstancesGetResponse |
Contains response data for the get operation. |
ProviderInstancesListNextResponse |
Contains response data for the listNext operation. |
ProviderInstancesListResponse |
Contains response data for the list operation. |
ProviderSpecificPropertiesUnion | |
RoutingPreference |
Defines values for RoutingPreference. Known values supported by the serviceDefault |
SAPApplicationServerInstancesCreateResponse |
Contains response data for the create operation. |
SAPApplicationServerInstancesDeleteResponse |
Contains response data for the delete operation. |
SAPApplicationServerInstancesGetResponse |
Contains response data for the get operation. |
SAPApplicationServerInstancesListNextResponse |
Contains response data for the listNext operation. |
SAPApplicationServerInstancesListResponse |
Contains response data for the list operation. |
SAPApplicationServerInstancesStartInstanceResponse |
Contains response data for the startInstance operation. |
SAPApplicationServerInstancesStopInstanceResponse |
Contains response data for the stopInstance operation. |
SAPApplicationServerInstancesUpdateResponse |
Contains response data for the update operation. |
SAPAvailabilityZoneDetailsResponse |
Contains response data for the sAPAvailabilityZoneDetails operation. |
SAPCentralInstancesCreateResponse |
Contains response data for the create operation. |
SAPCentralInstancesDeleteResponse |
Contains response data for the delete operation. |
SAPCentralInstancesGetResponse |
Contains response data for the get operation. |
SAPCentralInstancesListNextResponse |
Contains response data for the listNext operation. |
SAPCentralInstancesListResponse |
Contains response data for the list operation. |
SAPCentralInstancesStartInstanceResponse |
Contains response data for the startInstance operation. |
SAPCentralInstancesStopInstanceResponse |
Contains response data for the stopInstance operation. |
SAPCentralInstancesUpdateResponse |
Contains response data for the update operation. |
SAPConfigurationType |
Defines values for SAPConfigurationType. Known values supported by the serviceDeployment |
SAPConfigurationUnion | |
SAPDatabaseInstancesCreateResponse |
Contains response data for the create operation. |
SAPDatabaseInstancesDeleteResponse |
Contains response data for the delete operation. |
SAPDatabaseInstancesGetResponse |
Contains response data for the get operation. |
SAPDatabaseInstancesListNextResponse |
Contains response data for the listNext operation. |
SAPDatabaseInstancesListResponse |
Contains response data for the list operation. |
SAPDatabaseInstancesStartInstanceResponse |
Contains response data for the startInstance operation. |
SAPDatabaseInstancesStopInstanceResponse |
Contains response data for the stopInstance operation. |
SAPDatabaseInstancesUpdateResponse |
Contains response data for the update operation. |
SAPDatabaseScaleMethod |
Defines values for SAPDatabaseScaleMethod. Known values supported by the serviceScaleUp |
SAPDatabaseType |
Defines values for SAPDatabaseType. Known values supported by the serviceHANA |
SAPDeploymentType |
Defines values for SAPDeploymentType. Known values supported by the serviceSingleServer |
SAPDiskConfigurationsResponse |
Contains response data for the sAPDiskConfigurations operation. |
SAPEnvironmentType |
Defines values for SAPEnvironmentType. Known values supported by the serviceNonProd |
SAPHealthState |
Defines values for SAPHealthState. Known values supported by the serviceUnknown |
SAPHighAvailabilityType |
Defines values for SAPHighAvailabilityType. Known values supported by the serviceAvailabilitySet |
SAPProductType |
Defines values for SAPProductType. Known values supported by the serviceECC |
SAPSizingRecommendationResultUnion | |
SAPSizingRecommendationsResponse |
Contains response data for the sAPSizingRecommendations operation. |
SAPSoftwareInstallationType |
Defines values for SAPSoftwareInstallationType. Known values supported by the serviceServiceInitiated |
SAPSupportedSkuResponse |
Contains response data for the sAPSupportedSku operation. |
SAPVirtualInstanceState |
Defines values for SAPVirtualInstanceState. Known values supported by the serviceInfrastructureDeploymentPending |
SAPVirtualInstanceStatus |
Defines values for SAPVirtualInstanceStatus. Known values supported by the serviceStarting |
SAPVirtualInstancesCreateResponse |
Contains response data for the create operation. |
SAPVirtualInstancesDeleteResponse |
Contains response data for the delete operation. |
SAPVirtualInstancesGetResponse |
Contains response data for the get operation. |
SAPVirtualInstancesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
SAPVirtualInstancesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
SAPVirtualInstancesListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
SAPVirtualInstancesListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
SAPVirtualInstancesStartResponse |
Contains response data for the start operation. |
SAPVirtualInstancesStopResponse |
Contains response data for the stop operation. |
SAPVirtualInstancesUpdateResponse |
Contains response data for the update operation. |
SapLandscapeMonitorCreateResponse |
Contains response data for the create operation. |
SapLandscapeMonitorGetResponse |
Contains response data for the get operation. |
SapLandscapeMonitorListResponse |
Contains response data for the list operation. |
SapLandscapeMonitorProvisioningState |
Defines values for SapLandscapeMonitorProvisioningState. Known values supported by the serviceAccepted |
SapLandscapeMonitorUpdateResponse |
Contains response data for the update operation. |
SapVirtualInstanceProvisioningState |
Defines values for SapVirtualInstanceProvisioningState. Known values supported by the serviceSucceeded |
SingleServerCustomResourceNamesUnion | |
SoftwareConfigurationUnion | |
SslPreference |
Defines values for SslPreference. Known values supported by the serviceDisabled |
ThreeTierCustomResourceNamesUnion | |
WorkloadMonitorActionType |
Defines values for WorkloadMonitorActionType. Known values supported by the serviceNotSpecified |
WorkloadMonitorProvisioningState |
Defines values for WorkloadMonitorProvisioningState. Known values supported by the serviceAccepted |
Enums
Functions
get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.