Microsoft.OffAzure HyperVSites 2020-01-01

Bicep resource definition

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

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

Resource format

To create a Microsoft.OffAzure/HyperVSites resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OffAzure/HyperVSites@2020-01-01' = {
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    agentDetails: {
      keyVaultId: 'string'
      keyVaultUri: 'string'
    }
    applianceName: 'string'
    discoverySolutionId: 'string'
    servicePrincipalIdentityDetails: {
      aadAuthority: 'string'
      applicationId: 'string'
      audience: 'string'
      objectId: 'string'
      rawCertData: 'string'
      tenantId: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.OffAzure/HyperVSites

Name Description Value
eTag eTag for concurrency control. string
location Azure location in which Sites is created. string
name The resource name string (required)
properties Nested properties of Hyper-V site. SiteProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

HyperVSiteTags

Name Description Value

SiteAgentProperties

Name Description Value
keyVaultId Key vault ARM Id. string
keyVaultUri Key vault URI. string

SiteProperties

Name Description Value
agentDetails On-premises agent details. SiteAgentProperties
applianceName Appliance Name. string
discoverySolutionId ARM ID of migration hub solution for SDS. string
servicePrincipalIdentityDetails Service principal identity details used by agent for communication to the service. SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority AAD Authority URL which was used to request the token for the service principal. string
applicationId Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
audience Intended audience for the service principal. string
objectId Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
rawCertData Raw certificate data for building certificate expiry flows. string
tenantId Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string

ARM template resource definition

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

Usage Examples

Resource format

To create a Microsoft.OffAzure/HyperVSites resource, add the following JSON to your template.

{
  "type": "Microsoft.OffAzure/HyperVSites",
  "apiVersion": "2020-01-01",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "agentDetails": {
      "keyVaultId": "string",
      "keyVaultUri": "string"
    },
    "applianceName": "string",
    "discoverySolutionId": "string",
    "servicePrincipalIdentityDetails": {
      "aadAuthority": "string",
      "applicationId": "string",
      "audience": "string",
      "objectId": "string",
      "rawCertData": "string",
      "tenantId": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.OffAzure/HyperVSites

Name Description Value
apiVersion The api version '2020-01-01'
eTag eTag for concurrency control. string
location Azure location in which Sites is created. string
name The resource name string (required)
properties Nested properties of Hyper-V site. SiteProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.OffAzure/HyperVSites'

HyperVSiteTags

Name Description Value

SiteAgentProperties

Name Description Value
keyVaultId Key vault ARM Id. string
keyVaultUri Key vault URI. string

SiteProperties

Name Description Value
agentDetails On-premises agent details. SiteAgentProperties
applianceName Appliance Name. string
discoverySolutionId ARM ID of migration hub solution for SDS. string
servicePrincipalIdentityDetails Service principal identity details used by agent for communication to the service. SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority AAD Authority URL which was used to request the token for the service principal. string
applicationId Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
audience Intended audience for the service principal. string
objectId Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
rawCertData Raw certificate data for building certificate expiry flows. string
tenantId Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string

Terraform (AzAPI provider) resource definition

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

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

Resource format

To create a Microsoft.OffAzure/HyperVSites resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OffAzure/HyperVSites@2020-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    eTag = "string"
    properties = {
      agentDetails = {
        keyVaultId = "string"
        keyVaultUri = "string"
      }
      applianceName = "string"
      discoverySolutionId = "string"
      servicePrincipalIdentityDetails = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        rawCertData = "string"
        tenantId = "string"
      }
    }
  }
}

Property Values

Microsoft.OffAzure/HyperVSites

Name Description Value
eTag eTag for concurrency control. string
location Azure location in which Sites is created. string
name The resource name string (required)
properties Nested properties of Hyper-V site. SiteProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.OffAzure/HyperVSites@2020-01-01"

HyperVSiteTags

Name Description Value

SiteAgentProperties

Name Description Value
keyVaultId Key vault ARM Id. string
keyVaultUri Key vault URI. string

SiteProperties

Name Description Value
agentDetails On-premises agent details. SiteAgentProperties
applianceName Appliance Name. string
discoverySolutionId ARM ID of migration hub solution for SDS. string
servicePrincipalIdentityDetails Service principal identity details used by agent for communication to the service. SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority AAD Authority URL which was used to request the token for the service principal. string
applicationId Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
audience Intended audience for the service principal. string
objectId Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
rawCertData Raw certificate data for building certificate expiry flows. string
tenantId Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string
  • Last updated on