Microsoft.TimeSeriesInsights environments/accessPolicies 2017-11-15
Bicep resource definition
The environments/accessPolicies 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.TimeSeriesInsights/environments/accessPolicies resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-11-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
principalObjectId: 'string'
roles: [
'string'
]
}
}
Property values
environments/accessPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters |
| 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: environments |
| properties | AccessPolicyResourceProperties (required) |
AccessPolicyResourceProperties
| Name | Description | Value |
|---|---|---|
| description | An description of the access policy. | string |
| principalObjectId | The objectId of the principal in Azure Active Directory. | string |
| roles | The list of roles the principal is assigned on the environment. | String array containing any of: 'Contributor' 'Reader' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a Pay As You Go (PAYG) Environment with an IoT Hub |
This template enables you to deploy a Pay As You Go (PAYG) Time Series Insights environment that is configured to consume events from an IoT Hub. |
| Create an Environment with an Event Hub Event Source |
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub. |
ARM template resource definition
The environments/accessPolicies 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.TimeSeriesInsights/environments/accessPolicies resource, add the following JSON to your template.
{
"type": "Microsoft.TimeSeriesInsights/environments/accessPolicies",
"apiVersion": "2017-11-15",
"name": "string",
"properties": {
"description": "string",
"principalObjectId": "string",
"roles": [ "string" ]
}
}
Property values
environments/accessPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.TimeSeriesInsights/environments/accessPolicies' |
| apiVersion | The resource api version | '2017-11-15' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters |
| properties | AccessPolicyResourceProperties (required) |
AccessPolicyResourceProperties
| Name | Description | Value |
|---|---|---|
| description | An description of the access policy. | string |
| principalObjectId | The objectId of the principal in Azure Active Directory. | string |
| roles | The list of roles the principal is assigned on the environment. | String array containing any of: 'Contributor' 'Reader' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a Pay As You Go (PAYG) Environment with an IoT Hub |
This template enables you to deploy a Pay As You Go (PAYG) Time Series Insights environment that is configured to consume events from an IoT Hub. |
| Create an Environment with an Event Hub Event Source |
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub. |
Terraform (AzAPI provider) resource definition
The environments/accessPolicies 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.TimeSeriesInsights/environments/accessPolicies resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-11-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
principalObjectId = "string"
roles = [
"string"
]
}
})
}
Property values
environments/accessPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-11-15" |
| name | The resource name | string (required) Character limit: 1-90 Valid characters: Can't use: '<>%&:\?/# or control characters |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: environments |
| properties | AccessPolicyResourceProperties (required) |
AccessPolicyResourceProperties
| Name | Description | Value |
|---|---|---|
| description | An description of the access policy. | string |
| principalObjectId | The objectId of the principal in Azure Active Directory. | string |
| roles | The list of roles the principal is assigned on the environment. | String array containing any of: "Contributor" "Reader" |