Share via

Microsoft.Migrate assessmentProjects/servercollectors

  • Article

Bicep resource definition

The assessmentProjects/servercollectors resource type can be deployed to:

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

Resource format

To create a Microsoft.Migrate/assessmentProjects/servercollectors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Migrate/assessmentProjects/servercollectors@2019-10-01' = {
  name: 'string'
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    agentProperties: {
      spnDetails: {
        applicationId: 'string'
        audience: 'string'
        authority: 'string'
        objectId: 'string'
        tenantId: 'string'
      }
    }
    discoverySiteId: 'string'
  }
}

Property values

assessmentProjects/servercollectors

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: assessmentProjects
eTag string
properties CollectorProperties

CollectorProperties

Name Description Value
agentProperties CollectorAgentProperties
discoverySiteId The ARM id of the discovery service site. string

CollectorAgentProperties

Name Description Value
spnDetails CollectorBodyAgentSpnProperties

CollectorBodyAgentSpnProperties

Name Description Value
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
authority AAD Authority URL which was used to request the token 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
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 assessmentProjects/servercollectors resource type can be deployed to:

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

Resource format

To create a Microsoft.Migrate/assessmentProjects/servercollectors resource, add the following JSON to your template.

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

Property values

assessmentProjects/servercollectors

Name Description Value
type The resource type 'Microsoft.Migrate/assessmentProjects/servercollectors'
apiVersion The resource api version '2019-10-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
eTag string
properties CollectorProperties

CollectorProperties

Name Description Value
agentProperties CollectorAgentProperties
discoverySiteId The ARM id of the discovery service site. string

CollectorAgentProperties

Name Description Value
spnDetails CollectorBodyAgentSpnProperties

CollectorBodyAgentSpnProperties

Name Description Value
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
authority AAD Authority URL which was used to request the token 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
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 assessmentProjects/servercollectors resource type can be deployed to:

  • Resource groups

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

Resource format

To create a Microsoft.Migrate/assessmentProjects/servercollectors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Migrate/assessmentProjects/servercollectors@2019-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      agentProperties = {
        spnDetails = {
          applicationId = "string"
          audience = "string"
          authority = "string"
          objectId = "string"
          tenantId = "string"
        }
      }
      discoverySiteId = "string"
    }
    eTag = "string"
  })
}

Property values

assessmentProjects/servercollectors

Name Description Value
type The resource type "Microsoft.Migrate/assessmentProjects/servercollectors@2019-10-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: assessmentProjects
eTag string
properties CollectorProperties

CollectorProperties

Name Description Value
agentProperties CollectorAgentProperties
discoverySiteId The ARM id of the discovery service site. string

CollectorAgentProperties

Name Description Value
spnDetails CollectorBodyAgentSpnProperties

CollectorBodyAgentSpnProperties

Name Description Value
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
authority AAD Authority URL which was used to request the token 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
tenantId Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string