Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The assessmentProjects/webAppCollectors 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.Migrate/assessmentProjects/webAppCollectors resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Migrate/assessmentProjects/webAppCollectors@2024-03-03-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
agentProperties: {
id: 'string'
lastHeartbeatUtc: 'string'
spnDetails: {
applicationId: 'string'
audience: 'string'
authority: 'string'
objectId: 'string'
tenantId: 'string'
}
version: 'string'
}
discoverySiteId: 'string'
}
}
Property Values
Microsoft.Migrate/assessmentProjects/webAppCollectors
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[^<>&:\?/#]{1,260}$ (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 |
| properties | The resource-specific properties for this resource. | CollectorPropertiesBaseWithAgent |
CollectorAgentPropertiesBase
| Name | Description | Value |
|---|---|---|
| id | Gets the collector agent id. | string |
| lastHeartbeatUtc | Gets the collector last heartbeat time. | string |
| spnDetails | Gets or sets the SPN details. | CollectorAgentSpnPropertiesBase |
| version | Gets the collector agent version. | string |
CollectorAgentSpnPropertiesBase
| Name | Description | Value |
|---|---|---|
| applicationId | Gets the AAD application id. | string |
| audience | Gets the AAD audience url. | string |
| authority | Gets the AAD authority endpoint. | string |
| objectId | Gets the object id of the AAD application. | string |
| tenantId | Gets the tenant id of the AAD application. | string |
CollectorPropertiesBaseWithAgent
| Name | Description | Value |
|---|---|---|
| agentProperties | Gets or sets the collector agent properties. | CollectorAgentPropertiesBase |
| discoverySiteId | Gets the discovery site id. | string |
ARM template resource definition
The assessmentProjects/webAppCollectors 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.Migrate/assessmentProjects/webAppCollectors resource, add the following JSON to your template.
{
"type": "Microsoft.Migrate/assessmentProjects/webAppCollectors",
"apiVersion": "2024-03-03-preview",
"name": "string",
"properties": {
"agentProperties": {
"id": "string",
"lastHeartbeatUtc": "string",
"spnDetails": {
"applicationId": "string",
"audience": "string",
"authority": "string",
"objectId": "string",
"tenantId": "string"
},
"version": "string"
},
"discoverySiteId": "string"
}
}
Property Values
Microsoft.Migrate/assessmentProjects/webAppCollectors
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-03-03-preview' |
| name | The resource name | string Constraints: Pattern = ^[^<>&:\?/#]{1,260}$ (required) |
| properties | The resource-specific properties for this resource. | CollectorPropertiesBaseWithAgent |
| type | The resource type | 'Microsoft.Migrate/assessmentProjects/webAppCollectors' |
CollectorAgentPropertiesBase
| Name | Description | Value |
|---|---|---|
| id | Gets the collector agent id. | string |
| lastHeartbeatUtc | Gets the collector last heartbeat time. | string |
| spnDetails | Gets or sets the SPN details. | CollectorAgentSpnPropertiesBase |
| version | Gets the collector agent version. | string |
CollectorAgentSpnPropertiesBase
| Name | Description | Value |
|---|---|---|
| applicationId | Gets the AAD application id. | string |
| audience | Gets the AAD audience url. | string |
| authority | Gets the AAD authority endpoint. | string |
| objectId | Gets the object id of the AAD application. | string |
| tenantId | Gets the tenant id of the AAD application. | string |
CollectorPropertiesBaseWithAgent
| Name | Description | Value |
|---|---|---|
| agentProperties | Gets or sets the collector agent properties. | CollectorAgentPropertiesBase |
| discoverySiteId | Gets the discovery site id. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The assessmentProjects/webAppCollectors 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.Migrate/assessmentProjects/webAppCollectors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Migrate/assessmentProjects/webAppCollectors@2024-03-03-preview"
name = "string"
parent_id = "string"
body = {
properties = {
agentProperties = {
id = "string"
lastHeartbeatUtc = "string"
spnDetails = {
applicationId = "string"
audience = "string"
authority = "string"
objectId = "string"
tenantId = "string"
}
version = "string"
}
discoverySiteId = "string"
}
}
}
Property Values
Microsoft.Migrate/assessmentProjects/webAppCollectors
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[^<>&:\?/#]{1,260}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: assessmentProjects |
| properties | The resource-specific properties for this resource. | CollectorPropertiesBaseWithAgent |
| type | The resource type | "Microsoft.Migrate/assessmentProjects/webAppCollectors@2024-03-03-preview" |
CollectorAgentPropertiesBase
| Name | Description | Value |
|---|---|---|
| id | Gets the collector agent id. | string |
| lastHeartbeatUtc | Gets the collector last heartbeat time. | string |
| spnDetails | Gets or sets the SPN details. | CollectorAgentSpnPropertiesBase |
| version | Gets the collector agent version. | string |
CollectorAgentSpnPropertiesBase
| Name | Description | Value |
|---|---|---|
| applicationId | Gets the AAD application id. | string |
| audience | Gets the AAD audience url. | string |
| authority | Gets the AAD authority endpoint. | string |
| objectId | Gets the object id of the AAD application. | string |
| tenantId | Gets the tenant id of the AAD application. | string |
CollectorPropertiesBaseWithAgent
| Name | Description | Value |
|---|---|---|
| agentProperties | Gets or sets the collector agent properties. | CollectorAgentPropertiesBase |
| discoverySiteId | Gets the discovery site id. | string |