Share via


@azure/arm-workloadssapvirtualinstance 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 be pre-created.

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.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

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.

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. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

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.

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.

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

OperationStatusResult

The current status of an async operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

OsSapConfiguration

Defines the OS and SAP Configurations for Deployment

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
SAPApplicationServerInstance

Define the SAP Application Server Instance resource.

SAPApplicationServerInstancesCreateOptionalParams

Optional parameters.

SAPApplicationServerInstancesDeleteOptionalParams

Optional parameters.

SAPApplicationServerInstancesGetOptionalParams

Optional parameters.

SAPApplicationServerInstancesListOptionalParams

Optional parameters.

SAPApplicationServerInstancesOperations

Interface representing a SAPApplicationServerInstances operations.

SAPApplicationServerInstancesStartOptionalParams

Optional parameters.

SAPApplicationServerInstancesStopOptionalParams

Optional parameters.

SAPApplicationServerInstancesUpdateOptionalParams

Optional parameters.

SAPApplicationServerProperties

Defines the SAP Application Server instance properties.

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.

SAPCentralServerInstance

Define the SAP Central Services Instance resource.

SAPCentralServerInstancesCreateOptionalParams

Optional parameters.

SAPCentralServerInstancesDeleteOptionalParams

Optional parameters.

SAPCentralServerInstancesGetOptionalParams

Optional parameters.

SAPCentralServerInstancesListOptionalParams

Optional parameters.

SAPCentralServerInstancesOperations

Interface representing a SAPCentralServerInstances operations.

SAPCentralServerInstancesStartOptionalParams

Optional parameters.

SAPCentralServerInstancesStopOptionalParams

Optional parameters.

SAPCentralServerInstancesUpdateOptionalParams

Optional parameters.

SAPCentralServerProperties

Defines the SAP Central Services Instance properties.

SAPConfiguration

The SAP Configuration.

SAPDatabaseInstance

Define the Database resource.

SAPDatabaseInstancesCreateOptionalParams

Optional parameters.

SAPDatabaseInstancesDeleteOptionalParams

Optional parameters.

SAPDatabaseInstancesGetOptionalParams

Optional parameters.

SAPDatabaseInstancesListOptionalParams

Optional parameters.

SAPDatabaseInstancesOperations

Interface representing a SAPDatabaseInstances operations.

SAPDatabaseInstancesStartOptionalParams

Optional parameters.

SAPDatabaseInstancesStopOptionalParams

Optional parameters.

SAPDatabaseInstancesUpdateOptionalParams

Optional parameters.

SAPDatabaseProperties

Defines the Database properties.

SAPDiskConfiguration

The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type.

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.

SAPSupportedResourceSkusResult

The list of supported SKUs for different resources which are part of SAP deployment.

SAPSupportedSku

The SAP supported SKU.

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.

SAPVirtualInstanceIdentity

Managed service identity (user assigned identities)

SAPVirtualInstanceProperties

Defines the Virtual Instance for SAP solutions resource properties.

SAPVirtualInstancesCreateOptionalParams

Optional parameters.

SAPVirtualInstancesDeleteOptionalParams

Optional parameters.

SAPVirtualInstancesGetAvailabilityZoneDetailsOptionalParams

Optional parameters.

SAPVirtualInstancesGetDiskConfigurationsOptionalParams

Optional parameters.

SAPVirtualInstancesGetOptionalParams

Optional parameters.

SAPVirtualInstancesGetSapSupportedSkuOptionalParams

Optional parameters.

SAPVirtualInstancesGetSizingRecommendationsOptionalParams

Optional parameters.

SAPVirtualInstancesListByResourceGroupOptionalParams

Optional parameters.

SAPVirtualInstancesListBySubscriptionOptionalParams

Optional parameters.

SAPVirtualInstancesOperations

Interface representing a SAPVirtualInstances operations.

SAPVirtualInstancesStartOptionalParams

Optional parameters.

SAPVirtualInstancesStopOptionalParams

Optional parameters.

SAPVirtualInstancesUpdateOptionalParams

Optional parameters.

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. For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

StartRequest

Start SAP instance(s) request body.

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.

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'

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.

UpdateSAPVirtualInstanceProperties

Defines the update request body properties for updating Virtual Instance for SAP.

UpdateSAPVirtualInstanceRequest

Defines the request body for updating Virtual Instance for SAP.

UserAssignedIdentity

User assigned identity properties

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 for the client.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

ApplicationServerVirtualMachineType

Defines the type of application server VM.
KnownApplicationServerVirtualMachineType can be used interchangeably with ApplicationServerVirtualMachineType, this enum contains the known values that the service supports.

Known values supported by the service

Active: Active Application server vm type.
Standby: Standby Application server vm type.
Unknown: Unknown Application server vm type.

CentralServerVirtualMachineType

Defines the type of central server VM.
KnownCentralServerVirtualMachineType can be used interchangeably with CentralServerVirtualMachineType, this enum contains the known values that the service supports.

Known values supported by the service

Primary: Primary central server vm.
Secondary: Secondary central server vm.
Unknown: Central server vm type unknown.
ASCS: ASCS Central server vm type.
ERSInactive: ERSInactive Central server vm type.
ERS: ERS Central server vm type.
Standby: Standby Central server vm type.

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
<xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DiskSkuName

Defines the disk sku name.
KnownDiskSkuName can be used interchangeably with DiskSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS: Standard LRS Disk SKU.
Premium_LRS: Premium_LRS Disk SKU.
StandardSSD_LRS: StandardSSD_LRS Disk SKU.
UltraSSD_LRS: UltraSSD_LRS Disk SKU.
Premium_ZRS: Premium_ZRS Disk SKU.
StandardSSD_ZRS: StandardSSD_ZRS Disk SKU.
PremiumV2_LRS: PremiumV2_LRS Disk SKU.

EnqueueReplicationServerType

Defines the type of Enqueue Replication Server.
KnownEnqueueReplicationServerType can be used interchangeably with EnqueueReplicationServerType, this enum contains the known values that the service supports.

Known values supported by the service

EnqueueReplicator1: Enqueue Replication server type 1.
EnqueueReplicator2: Enqueue Replication server type 2.

FileShareConfigurationType

The type of file share config.
KnownFileShareConfigurationType can be used interchangeably with FileShareConfigurationType, this enum contains the known values that the service supports.

Known values supported by the service

Skip: Skip creating the file share.
CreateAndMount: Fileshare will be created and mounted by service.
Mount: Existing fileshare provided will be mounted by service.

FileShareConfigurationUnion

Alias for FileShareConfigurationUnion

InfrastructureConfigurationUnion

Alias for InfrastructureConfigurationUnion

ManagedResourcesNetworkAccessType

Defines the network access type for managed resources.
KnownManagedResourcesNetworkAccessType can be used interchangeably with ManagedResourcesNetworkAccessType, this enum contains the known values that the service supports.

Known values supported by the service

Public: Managed resources will be deployed with public network access enabled.
Private: Managed resources will be deployed with public network access disabled.

NamingPatternType

The pattern type to be used for resource naming.
KnownNamingPatternType can be used interchangeably with NamingPatternType, this enum contains the known values that the service supports.

Known values supported by the service

FullResourceName: Full resource names that will be created by service.

OSConfigurationUnion

Alias for OSConfigurationUnion

OSType

The OS Type
KnownOSType can be used interchangeably with OSType, this enum contains the known values that the service supports.

Known values supported by the service

Linux: Linux OS Type.
Windows: Windows OS Type.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

SAPConfigurationType

The configuration Type.
KnownSAPConfigurationType can be used interchangeably with SAPConfigurationType, this enum contains the known values that the service supports.

Known values supported by the service

Deployment: SAP system will be deployed by service. No OS configurations will be done.
Discovery: Existing SAP system will be registered.
DeploymentWithOSConfig: SAP system will be deployed by service. OS configurations will be done.

SAPConfigurationUnion

Alias for SAPConfigurationUnion

SAPDatabaseScaleMethod

The database scale method.
KnownSAPDatabaseScaleMethod can be used interchangeably with SAPDatabaseScaleMethod, this enum contains the known values that the service supports.

Known values supported by the service

ScaleUp: ScaleUp Hana Database deployment type

SAPDatabaseType

Defines the supported SAP Database types.
KnownSAPDatabaseType can be used interchangeably with SAPDatabaseType, this enum contains the known values that the service supports.

Known values supported by the service

HANA: HANA Database type of SAP system.
DB2: DB2 database type of the SAP system.

SAPDeploymentType

The type of SAP deployment, single server or Three tier.
KnownSAPDeploymentType can be used interchangeably with SAPDeploymentType, this enum contains the known values that the service supports.

Known values supported by the service

SingleServer: SAP Single server deployment type.
ThreeTier: SAP Distributed deployment type.

SAPEnvironmentType

Defines the environment type - Production/Non Production.
KnownSAPEnvironmentType can be used interchangeably with SAPEnvironmentType, this enum contains the known values that the service supports.

Known values supported by the service

NonProd: Non Production SAP system.
Prod: Production SAP system.

SAPHealthState

Defines the health of SAP Instances.
KnownSAPHealthState can be used interchangeably with SAPHealthState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: SAP System health is unknown.
Healthy: SAP System health is healthy.
Unhealthy: SAP System is unhealthy.
Degraded: SAP System health is degraded.

SAPHighAvailabilityType

The high availability type (AvailabilitySet or AvailabilityZone).
KnownSAPHighAvailabilityType can be used interchangeably with SAPHighAvailabilityType, this enum contains the known values that the service supports.

Known values supported by the service

AvailabilitySet: HA deployment with availability sets.
AvailabilityZone: HA deployment with availability zones.

SAPProductType

Defines the SAP Product type.
KnownSAPProductType can be used interchangeably with SAPProductType, this enum contains the known values that the service supports.

Known values supported by the service

ECC: SAP Product ECC.
S4HANA: SAP Product S4HANA.
Other: SAP Products other than the ones listed.

SAPSizingRecommendationResultUnion

Alias for SAPSizingRecommendationResultUnion

SAPSoftwareInstallationType

The SAP software installation Type.
KnownSAPSoftwareInstallationType can be used interchangeably with SAPSoftwareInstallationType, this enum contains the known values that the service supports.

Known values supported by the service

ServiceInitiated: SAP Install managed by service.
SAPInstallWithoutOSConfig: SAP Install without OS Config.
External: External software installation type.

SAPVirtualInstanceIdentityType

Type of managed service identity (where only None and UserAssigned types are allowed).
KnownSAPVirtualInstanceIdentityType can be used interchangeably with SAPVirtualInstanceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
UserAssigned: User assigned managed identity.

SAPVirtualInstanceState

Defines the Virtual Instance for SAP state.
KnownSAPVirtualInstanceState can be used interchangeably with SAPVirtualInstanceState, this enum contains the known values that the service supports.

Known values supported by the service

InfrastructureDeploymentPending: Infrastructure is not yet deployed.
InfrastructureDeploymentInProgress: Infrastructure deployment is in progress.
InfrastructureDeploymentFailed: Infrastructure deployment has failed.
SoftwareInstallationPending: Infrastructure deployment is successful. Software installation is pending.
SoftwareInstallationInProgress: Software installation is in progress.
SoftwareInstallationFailed: Software installation failed.
SoftwareDetectionInProgress: Software detection is in progress.
SoftwareDetectionFailed: Software detection failed.
DiscoveryPending: Registration has not started.
DiscoveryInProgress: Registration is in progress.
DiscoveryFailed: Registration has failed.
RegistrationComplete: Registration is complete.
ACSSInstallationBlocked: ACSS installation cannot proceed.

SAPVirtualInstanceStatus

Defines the SAP Instance status.
KnownSAPVirtualInstanceStatus can be used interchangeably with SAPVirtualInstanceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Starting: SAP system is getting started.
Running: SAP system is running.
Stopping: SAP system is being stopped.
Offline: SAP system is offline.
PartiallyRunning: SAP system is partially running.
Unavailable: SAP system status is unavailable.
SoftShutdown: Soft shutdown of SAP system is initiated.

SapVirtualInstanceProvisioningState

Defines the provisioning states.
KnownSapVirtualInstanceProvisioningState can be used interchangeably with SapVirtualInstanceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: ACSS succeeded provisioning state.
Updating: ACSS updating provisioning state.
Creating: ACSS Creating provisioning state.
Failed: ACSS Failed provisioning state.
Deleting: ACSS Deleting provisioning state.
Canceled: ACSS Canceled provisioning state.

SingleServerCustomResourceNamesUnion

Alias for SingleServerCustomResourceNamesUnion

SoftwareConfigurationUnion

Alias for SoftwareConfigurationUnion

ThreeTierCustomResourceNamesUnion

Alias for ThreeTierCustomResourceNamesUnion

Enums

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownApplicationServerVirtualMachineType

Defines the type of application server VM.

KnownCentralServerVirtualMachineType

Defines the type of central server VM.

KnownCreatedByType

The kind of entity that created the resource.

KnownDiskSkuName

Defines the disk sku name.

KnownEnqueueReplicationServerType

Defines the type of Enqueue Replication Server.

KnownFileShareConfigurationType

The type of file share config.

KnownManagedResourcesNetworkAccessType

Defines the network access type for managed resources.

KnownNamingPatternType

The pattern type to be used for resource naming.

KnownOSType

The OS Type

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownSAPConfigurationType

The configuration Type.

KnownSAPDatabaseScaleMethod

The database scale method.

KnownSAPDatabaseType

Defines the supported SAP Database types.

KnownSAPDeploymentType

The type of SAP deployment, single server or Three tier.

KnownSAPEnvironmentType

Defines the environment type - Production/Non Production.

KnownSAPHealthState

Defines the health of SAP Instances.

KnownSAPHighAvailabilityType

The high availability type (AvailabilitySet or AvailabilityZone).

KnownSAPProductType

Defines the SAP Product type.

KnownSAPSoftwareInstallationType

The SAP software installation Type.

KnownSAPVirtualInstanceIdentityType

Type of managed service identity (where only None and UserAssigned types are allowed).

KnownSAPVirtualInstanceState

Defines the Virtual Instance for SAP state.

KnownSAPVirtualInstanceStatus

Defines the SAP Instance status.

KnownSapVirtualInstanceProvisioningState

Defines the provisioning states.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(WorkloadsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(WorkloadsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: WorkloadsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>