Microsoft.OffAzure hypervSites 2023-06-06

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@2023-06-06' = {
  location: 'string'
  name: 'string'
  properties: {
    agentDetails: {
      keyVaultId: 'string'
      keyVaultUri: 'string'
    }
    applianceName: 'string'
    discoverySolutionId: 'string'
    provisioningState: '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
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. SiteProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

SiteAgentProperties

Name Description Value
keyVaultId Gets or sets the key vault ARM Id. string
keyVaultUri Gets or sets the key vault URI. string

SiteProperties

Name Description Value
agentDetails Gets or sets the on-premises agent details. SiteAgentProperties
applianceName Gets or sets the Appliance Name. string
discoverySolutionId Gets or sets the ARM ID of migration hub solution for SDS. string
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
servicePrincipalIdentityDetails Gets or sets the service principal identity details used by agent for
communication
to the service.		 SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority Gets or sets the AAD Authority URL which was used to request the token for
the
service principal.		 string
applicationId Gets or sets the application/client Id for the service principal with which
the
on-premise management/data plane components would communicate
with our Azure
services.		 string
audience Gets or sets the intended audience for the service principal. string
objectId Gets or sets the object Id of the service principal with which the on-premise

management/data plane components would communicate with our Azure
services.		 string
rawCertData Gets or sets the raw certificate data for building certificate expiry flows. string
tenantId Gets or sets the tenant Id for the service principal with which the
on-premise
management/data plane components would communicate with
our Azure services.		 string

TrackedResourceTags

Name Description Value

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": "2023-06-06",
  "name": "string",
  "location": "string",
  "properties": {
    "agentDetails": {
      "keyVaultId": "string",
      "keyVaultUri": "string"
    },
    "applianceName": "string",
    "discoverySolutionId": "string",
    "provisioningState": "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 '2023-06-06'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. SiteProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.OffAzure/hypervSites'

SiteAgentProperties

Name Description Value
keyVaultId Gets or sets the key vault ARM Id. string
keyVaultUri Gets or sets the key vault URI. string

SiteProperties

Name Description Value
agentDetails Gets or sets the on-premises agent details. SiteAgentProperties
applianceName Gets or sets the Appliance Name. string
discoverySolutionId Gets or sets the ARM ID of migration hub solution for SDS. string
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
servicePrincipalIdentityDetails Gets or sets the service principal identity details used by agent for
communication
to the service.		 SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority Gets or sets the AAD Authority URL which was used to request the token for
the
service principal.		 string
applicationId Gets or sets the application/client Id for the service principal with which
the
on-premise management/data plane components would communicate
with our Azure
services.		 string
audience Gets or sets the intended audience for the service principal. string
objectId Gets or sets the object Id of the service principal with which the on-premise

management/data plane components would communicate with our Azure
services.		 string
rawCertData Gets or sets the raw certificate data for building certificate expiry flows. string
tenantId Gets or sets the tenant Id for the service principal with which the
on-premise
management/data plane components would communicate with
our Azure services.		 string

TrackedResourceTags

Name Description Value

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@2023-06-06"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      agentDetails = {
        keyVaultId = "string"
        keyVaultUri = "string"
      }
      applianceName = "string"
      discoverySolutionId = "string"
      provisioningState = "string"
      servicePrincipalIdentityDetails = {
        aadAuthority = "string"
        applicationId = "string"
        audience = "string"
        objectId = "string"
        rawCertData = "string"
        tenantId = "string"
      }
    }
  }
}

Property Values

Microsoft.OffAzure/hypervSites

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. SiteProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.OffAzure/hypervSites@2023-06-06"

SiteAgentProperties

Name Description Value
keyVaultId Gets or sets the key vault ARM Id. string
keyVaultUri Gets or sets the key vault URI. string

SiteProperties

Name Description Value
agentDetails Gets or sets the on-premises agent details. SiteAgentProperties
applianceName Gets or sets the Appliance Name. string
discoverySolutionId Gets or sets the ARM ID of migration hub solution for SDS. string
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
servicePrincipalIdentityDetails Gets or sets the service principal identity details used by agent for
communication
to the service.		 SiteSpnProperties

SiteSpnProperties

Name Description Value
aadAuthority Gets or sets the AAD Authority URL which was used to request the token for
the
service principal.		 string
applicationId Gets or sets the application/client Id for the service principal with which
the
on-premise management/data plane components would communicate
with our Azure
services.		 string
audience Gets or sets the intended audience for the service principal. string
objectId Gets or sets the object Id of the service principal with which the on-premise

management/data plane components would communicate with our Azure
services.		 string
rawCertData Gets or sets the raw certificate data for building certificate expiry flows. string
tenantId Gets or sets the tenant Id for the service principal with which the
on-premise
management/data plane components would communicate with
our Azure services.		 string

TrackedResourceTags

Name Description Value
  • Last updated on