Microsoft.Devices provisioningServices 2022-02-05
Definição de recurso do Bicep
O tipo de recurso provisioningServices pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Devices/provisioningServices@2022-02-05' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
allocationPolicy: 'string'
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
enableDataResidency: bool
iotHubs: [
{
allocationWeight: int
applyAllocationPolicy: bool
connectionString: 'string'
location: 'string'
}
]
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
target: 'string'
}
]
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
provisioningState: 'string'
publicNetworkAccess: 'string'
state: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a ser usada por esse serviço de provisionamento. | 'GeoLatency' 'Hashed' 'Estático' |
| authorizationPolicies | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastre entre pares geográficos. |
Bool |
| iotHubs | Lista de hubs IoT associados a esse serviço de provisionamento. | IotHubDefinitionDescription [] |
| ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
| privateEndpointConnections | Conexões de ponto de extremidade privado criadas neste IotHub | PrivateEndpointConnection [] |
| provisioningState | O estado de provisionamento do ARM do serviço de provisionamento. | corda |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desabilitado' 'Habilitado' |
| estado | Estado atual do serviço de provisionamento. | 'Ativando' 'ActivationFailed' 'Ativo' 'Excluído' 'Excluindo' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Resumindo' 'Suspenso' 'Suspendendo' 'Transição' |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a serem provisionadas | int |
| nome | Nome do SKU. | 'S1' |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a ser aplicado a um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | Bool |
| connectionString | Cadeia de conexão do hub IoT. | cadeia de caracteres (obrigatório) |
| localização | Região do ARM do hub IoT. | cadeia de caracteres (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
| filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
| alvo | Destino para solicitações capturadas por essa regra. | 'all' 'deviceApi' 'serviceApi' |
Microsoft.Devices/provisioningServices
| Nome | Descrição | Valor |
|---|---|---|
| etag | O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | corda |
| localização | O local do recurso. | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Propriedades específicas do serviço para um serviço de provisionamento | IotDpsPropertiesDescription (obrigatório) |
| Sku | Informações de SKU para um serviço de provisionamento. | IotDpsSkuInfo (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
PrivateEndpoint
| Nome | Descrição | Valor |
|---|
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| Propriedades | As propriedades de uma conexão de ponto de extremidade privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | corda |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| estado | O status de uma conexão de ponto de extremidade privado | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório) |
ResourceTags
| Nome | Descrição | Valor |
|---|
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia de caracteres (obrigatório) |
| primaryKey | Valor da chave SAS primária. | corda |
| direitos | Direitos que essa chave tem. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
| secondaryKey | Valor de chave SAS secundário. | corda |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| criar um serviço de provisionamento de dispositivos do Hub IoT | Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos. |
Definição de recurso de modelo do ARM
O tipo de recurso provisioningServices pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2022-02-05",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"allocationPolicy": "string",
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"enableDataResidency": "bool",
"iotHubs": [
{
"allocationWeight": "int",
"applyAllocationPolicy": "bool",
"connectionString": "string",
"location": "string"
}
],
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string",
"target": "string"
}
],
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"provisioningState": "string",
"publicNetworkAccess": "string",
"state": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a ser usada por esse serviço de provisionamento. | 'GeoLatency' 'Hashed' 'Estático' |
| authorizationPolicies | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastre entre pares geográficos. |
Bool |
| iotHubs | Lista de hubs IoT associados a esse serviço de provisionamento. | IotHubDefinitionDescription [] |
| ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
| privateEndpointConnections | Conexões de ponto de extremidade privado criadas neste IotHub | PrivateEndpointConnection [] |
| provisioningState | O estado de provisionamento do ARM do serviço de provisionamento. | corda |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desabilitado' 'Habilitado' |
| estado | Estado atual do serviço de provisionamento. | 'Ativando' 'ActivationFailed' 'Ativo' 'Excluído' 'Excluindo' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Resumindo' 'Suspenso' 'Suspendendo' 'Transição' |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a serem provisionadas | int |
| nome | Nome do SKU. | 'S1' |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a ser aplicado a um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | Bool |
| connectionString | Cadeia de conexão do hub IoT. | cadeia de caracteres (obrigatório) |
| localização | Região do ARM do hub IoT. | cadeia de caracteres (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
| filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
| alvo | Destino para solicitações capturadas por essa regra. | 'all' 'deviceApi' 'serviceApi' |
Microsoft.Devices/provisioningServices
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2022-02-05' |
| etag | O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | corda |
| localização | O local do recurso. | cadeia de caracteres (obrigatório) |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Propriedades específicas do serviço para um serviço de provisionamento | IotDpsPropertiesDescription (obrigatório) |
| Sku | Informações de SKU para um serviço de provisionamento. | IotDpsSkuInfo (obrigatório) |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
| tipo | O tipo de recurso | 'Microsoft.Devices/provisioningServices' |
PrivateEndpoint
| Nome | Descrição | Valor |
|---|
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| Propriedades | As propriedades de uma conexão de ponto de extremidade privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | corda |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| estado | O status de uma conexão de ponto de extremidade privado | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório) |
ResourceTags
| Nome | Descrição | Valor |
|---|
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia de caracteres (obrigatório) |
| primaryKey | Valor da chave SAS primária. | corda |
| direitos | Direitos que essa chave tem. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
| secondaryKey | Valor de chave SAS secundário. | corda |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar um Hub IOT e um simulador de borda do Ubuntu
|
Esse modelo cria um simulador de borda do Ubuntu do Hub IOT e da Máquina Virtual. |
|
criar um serviço de provisionamento de dispositivos do Hub IoT
|
Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso provisioningServices pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2022-02-05"
name = "string"
etag = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
allocationPolicy = "string"
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
enableDataResidency = bool
iotHubs = [
{
allocationWeight = int
applyAllocationPolicy = bool
connectionString = "string"
location = "string"
}
]
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
target = "string"
}
]
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
provisioningState = "string"
publicNetworkAccess = "string"
state = "string"
}
})
}
Valores de propriedade
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a ser usada por esse serviço de provisionamento. | 'GeoLatency' 'Hashed' 'Estático' |
| authorizationPolicies | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastre entre pares geográficos. |
Bool |
| iotHubs | Lista de hubs IoT associados a esse serviço de provisionamento. | IotHubDefinitionDescription [] |
| ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
| privateEndpointConnections | Conexões de ponto de extremidade privado criadas neste IotHub | PrivateEndpointConnection [] |
| provisioningState | O estado de provisionamento do ARM do serviço de provisionamento. | corda |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desabilitado' 'Habilitado' |
| estado | Estado atual do serviço de provisionamento. | 'Ativando' 'ActivationFailed' 'Ativo' 'Excluído' 'Excluindo' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Resumindo' 'Suspenso' 'Suspendendo' 'Transição' |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a serem provisionadas | int |
| nome | Nome do SKU. | 'S1' |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a ser aplicado a um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | Bool |
| connectionString | Cadeia de conexão do hub IoT. | cadeia de caracteres (obrigatório) |
| localização | Região do ARM do hub IoT. | cadeia de caracteres (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
| filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
| alvo | Destino para solicitações capturadas por essa regra. | 'all' 'deviceApi' 'serviceApi' |
Microsoft.Devices/provisioningServices
PrivateEndpoint
| Nome | Descrição | Valor |
|---|
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| Propriedades | As propriedades de uma conexão de ponto de extremidade privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | corda |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| estado | O status de uma conexão de ponto de extremidade privado | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório) |
ResourceTags
| Nome | Descrição | Valor |
|---|
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia de caracteres (obrigatório) |
| primaryKey | Valor da chave SAS primária. | corda |
| direitos | Direitos que essa chave tem. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
| secondaryKey | Valor de chave SAS secundário. | corda |