Microsoft.Migrate assessmentProjects/hypervcollectors template reference

Template format

To create a Microsoft.Migrate/assessmentProjects/hypervcollectors resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Migrate/assessmentProjects/hypervcollectors",
  "apiVersion": "2019-10-01",
  "properties": {
    "discoverySiteId": "string",
    "agentProperties": {
      "spnDetails": {
        "authority": "string",
        "applicationId": "string",
        "audience": "string",
        "objectId": "string",
        "tenantId": "string"
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Migrate/assessmentProjects/hypervcollectors object

Name Type Required Value
name string Yes Unique name of a Hyper-V collector within a project.
type enum Yes hypervcollectors
-or-
Microsoft.Migrate/assessmentProjects/hypervcollectors

See Set name and type for child resources.
apiVersion enum Yes 2019-10-01
properties object Yes CollectorProperties object

CollectorProperties object

Name Type Required Value
discoverySiteId string No The ARM id of the discovery service site.
agentProperties object No CollectorAgentProperties object

CollectorAgentProperties object

Name Type Required Value
spnDetails object No CollectorBodyAgentSpnProperties object

CollectorBodyAgentSpnProperties object

Name Type Required Value
authority string No AAD Authority URL which was used to request the token for the service principal.
applicationId string No Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience string No Intended audience for the service principal.
objectId string No Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
tenantId string No Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.