Microsoft.Workloads sapVirtualInstances 2024-09-01

2024-12-09

Bicep resource definition

The sapVirtualInstances resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Workloads/sapVirtualInstances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Workloads/sapVirtualInstances@2024-09-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    configuration: {
      configurationType: 'string'
      // For remaining properties, see SAPConfiguration objects
    }
    environment: 'string'
    managedResourceGroupConfiguration: {
      name: 'string'
    }
    managedResourcesNetworkAccessType: 'string'
    sapProduct: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

InfrastructureConfiguration objects

Set the deploymentType property to specify the type of object.

For SingleServer, use:

{
  customResourceNames: {
    namingPatternType: 'string'
    // For remaining properties, see SingleServerCustomResourceNames objects
  }
  databaseType: 'string'
  dbDiskConfiguration: {
    diskVolumeConfigurations: {
      {customized property}: {
        count: int
        sizeGB: int
        sku: {
          name: 'string'
        }
      }
    }
  }
  deploymentType: 'SingleServer'
  networkConfiguration: {
    isSecondaryIpEnabled: bool
  }
  subnetId: 'string'
  virtualMachineConfiguration: {
    imageReference: {
      id: 'string'
      offer: 'string'
      publisher: 'string'
      sku: 'string'
      version: 'string'
    }
    osProfile: {
      adminPassword: 'string'
      adminUsername: 'string'
      osConfiguration: {
        osType: 'string'
        // For remaining properties, see OSConfiguration objects
      }
    }
    vmSize: 'string'
  }
}

For ThreeTier, use:

{
  applicationServer: {
    instanceCount: int
    subnetId: 'string'
    virtualMachineConfiguration: {
      imageReference: {
        id: 'string'
        offer: 'string'
        publisher: 'string'
        sku: 'string'
        version: 'string'
      }
      osProfile: {
        adminPassword: 'string'
        adminUsername: 'string'
        osConfiguration: {
          osType: 'string'
          // For remaining properties, see OSConfiguration objects
        }
      }
      vmSize: 'string'
    }
  }
  centralServer: {
    instanceCount: int
    subnetId: 'string'
    virtualMachineConfiguration: {
      imageReference: {
        id: 'string'
        offer: 'string'
        publisher: 'string'
        sku: 'string'
        version: 'string'
      }
      osProfile: {
        adminPassword: 'string'
        adminUsername: 'string'
        osConfiguration: {
          osType: 'string'
          // For remaining properties, see OSConfiguration objects
        }
      }
      vmSize: 'string'
    }
  }
  customResourceNames: {
    namingPatternType: 'string'
    // For remaining properties, see ThreeTierCustomResourceNames objects
  }
  databaseServer: {
    databaseType: 'string'
    diskConfiguration: {
      diskVolumeConfigurations: {
        {customized property}: {
          count: int
          sizeGB: int
          sku: {
            name: 'string'
          }
        }
      }
    }
    instanceCount: int
    subnetId: 'string'
    virtualMachineConfiguration: {
      imageReference: {
        id: 'string'
        offer: 'string'
        publisher: 'string'
        sku: 'string'
        version: 'string'
      }
      osProfile: {
        adminPassword: 'string'
        adminUsername: 'string'
        osConfiguration: {
          osType: 'string'
          // For remaining properties, see OSConfiguration objects
        }
      }
      vmSize: 'string'
    }
  }
  deploymentType: 'ThreeTier'
  highAvailabilityConfig: {
    highAvailabilityType: 'string'
  }
  networkConfiguration: {
    isSecondaryIpEnabled: bool
  }
  storageConfiguration: {
    transportFileShareConfiguration: {
      configurationType: 'string'
      // For remaining properties, see FileShareConfiguration objects
    }
  }
}

SingleServerCustomResourceNames objects

Set the namingPatternType property to specify the type of object.

For FullResourceName, use:

{
  namingPatternType: 'FullResourceName'
  virtualMachine: {
    dataDiskNames: {
      {customized property}: [
        'string'
      ]
    }
    hostName: 'string'
    networkInterfaces: [
      {
        networkInterfaceName: 'string'
      }
    ]
    osDiskName: 'string'
    vmName: 'string'
  }
}

OSConfiguration objects

Set the osType property to specify the type of object.

For Linux, use:

{
  disablePasswordAuthentication: bool
  osType: 'Linux'
  ssh: {
    publicKeys: [
      {
        keyData: 'string'
      }
    ]
  }
  sshKeyPair: {
    privateKey: 'string'
    publicKey: 'string'
  }
}

For Windows, use:

{
  osType: 'Windows'
}

SAPConfiguration objects

Set the configurationType property to specify the type of object.

For Deployment, use:

{
  appLocation: 'string'
  configurationType: 'Deployment'
  infrastructureConfiguration: {
    appResourceGroup: 'string'
    deploymentType: 'string'
    // For remaining properties, see InfrastructureConfiguration objects
  }
  softwareConfiguration: {
    softwareInstallationType: 'string'
    // For remaining properties, see SoftwareConfiguration objects
  }
}

For DeploymentWithOSConfig, use:

{
  appLocation: 'string'
  configurationType: 'DeploymentWithOSConfig'
  infrastructureConfiguration: {
    appResourceGroup: 'string'
    deploymentType: 'string'
    // For remaining properties, see InfrastructureConfiguration objects
  }
  osSapConfiguration: {
    deployerVmPackages: {
      storageAccountId: 'string'
      url: 'string'
    }
    sapFqdn: 'string'
  }
  softwareConfiguration: {
    softwareInstallationType: 'string'
    // For remaining properties, see SoftwareConfiguration objects
  }
}

For Discovery, use:

{
  centralServerVmId: 'string'
  configurationType: 'Discovery'
  managedRgStorageAccountName: 'string'
}

ThreeTierCustomResourceNames objects

Set the namingPatternType property to specify the type of object.

For FullResourceName, use:

{
  applicationServer: {
    availabilitySetName: 'string'
    virtualMachines: [
      {
        dataDiskNames: {
          {customized property}: [
            'string'
          ]
        }
        hostName: 'string'
        networkInterfaces: [
          {
            networkInterfaceName: 'string'
          }
        ]
        osDiskName: 'string'
        vmName: 'string'
      }
    ]
  }
  centralServer: {
    availabilitySetName: 'string'
    loadBalancer: {
      backendPoolNames: [
        'string'
      ]
      frontendIpConfigurationNames: [
        'string'
      ]
      healthProbeNames: [
        'string'
      ]
      loadBalancerName: 'string'
    }
    virtualMachines: [
      {
        dataDiskNames: {
          {customized property}: [
            'string'
          ]
        }
        hostName: 'string'
        networkInterfaces: [
          {
            networkInterfaceName: 'string'
          }
        ]
        osDiskName: 'string'
        vmName: 'string'
      }
    ]
  }
  databaseServer: {
    availabilitySetName: 'string'
    loadBalancer: {
      backendPoolNames: [
        'string'
      ]
      frontendIpConfigurationNames: [
        'string'
      ]
      healthProbeNames: [
        'string'
      ]
      loadBalancerName: 'string'
    }
    virtualMachines: [
      {
        dataDiskNames: {
          {customized property}: [
            'string'
          ]
        }
        hostName: 'string'
        networkInterfaces: [
          {
            networkInterfaceName: 'string'
          }
        ]
        osDiskName: 'string'
        vmName: 'string'
      }
    ]
  }
  namingPatternType: 'FullResourceName'
  sharedStorage: {
    sharedStorageAccountName: 'string'
    sharedStorageAccountPrivateEndPointName: 'string'
  }
}

FileShareConfiguration objects

Set the configurationType property to specify the type of object.

For CreateAndMount, use:

{
  configurationType: 'CreateAndMount'
  resourceGroup: 'string'
  storageAccountName: 'string'
}

For Mount, use:

{
  configurationType: 'Mount'
  id: 'string'
  privateEndpointId: 'string'
}

For Skip, use:

{
  configurationType: 'Skip'
}

SoftwareConfiguration objects

Set the softwareInstallationType property to specify the type of object.

For External, use:

{
  centralServerVmId: 'string'
  softwareInstallationType: 'External'
}

For SAPInstallWithoutOSConfig, use:

{
  bomUrl: 'string'
  highAvailabilitySoftwareConfiguration: {
    fencingClientId: 'string'
    fencingClientPassword: 'string'
  }
  sapBitsStorageAccountId: 'string'
  softwareInstallationType: 'SAPInstallWithoutOSConfig'
  softwareVersion: 'string'
}

For ServiceInitiated, use:

{
  bomUrl: 'string'
  highAvailabilitySoftwareConfiguration: {
    fencingClientId: 'string'
    fencingClientPassword: 'string'
  }
  sapBitsStorageAccountId: 'string'
  sapFqdn: 'string'
  softwareInstallationType: 'ServiceInitiated'
  softwareVersion: 'string'
  sshPrivateKey: 'string'
}

Property Values