Microsoft.Devices provisioningServices 2021-10-15
Definição de recurso do Bicep
O tipo de recurso provisioningServices pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'S1'
}
etag: 'string'
properties: {
allocationPolicy: 'string'
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
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
provisioningServices
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. Termine com alfanumérico. |
| localização | A localização do recurso. | cadeia (obrigatório) |
| etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | Informações de SKU para um Serviço de aprovisionamento. | IotDpsSkuInfo (obrigatório) |
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| propriedades | Propriedades específicas do serviço para um serviço de aprovisionamento | IotDpsPropertiesDescription (obrigatório) |
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a utilizar por este serviço de aprovisionamento. | "GeoLatency" 'Hashed' "Estático" |
| authorizationPolicies | Lista de chaves de autorização para um serviço de aprovisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
| enableDataResidency | Opcional. Indica se a instância do DPS Data Residency ativada, removendo a recuperação após desastre entre pares geográficos. |
bool |
| iotHubs | Lista de hubs IoT associados a este serviço de aprovisionamento. | IotHubDefinitionDescription[] |
| ipFilterRules | As regras de filtro de IP. | IpFilterRule[] |
| privateEndpointConnections | Ligações de ponto final privados criadas neste IotHub | PrivateEndpointConnection[] |
| provisioningState | O estado de aprovisionamento do ARM do serviço de aprovisionamento. | string |
| publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | "Desativado" "Ativado" |
| state | Estado atual do serviço de aprovisionamento. | "Ativar" "Ativação Falhada" "Ativo" "Eliminado" "A eliminar" "Eliminação Falhada" "Ativação Pós-falha" "Falha na Ativação Pós-falha" 'Retomar' "Suspenso" 'Suspender' "Transição" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS primária. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS primária. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a aplicar para um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | bool |
| connectionString | Cadeia de ligação do hub IoT. | cadeia (obrigatório) |
| localização | Região arm do hub IoT. | cadeia (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| action | A ação pretendida para pedidos capturados por esta regra. | "Aceitar" "Rejeitar" (obrigatório) |
| filterName | O nome da regra de filtro ip. | cadeia (obrigatório) |
| ipMask | Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra. | cadeia (obrigatório) |
| destino | Destino para pedidos capturados por esta regra. | 'all' "deviceApi" "serviceApi" |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Nome | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto final privado de uma ligação de ponto final privado | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma ligação de ponto final privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma ligação de ponto final privado | string |
| descrição | A descrição do estado atual de uma ligação de ponto final privado | cadeia (obrigatório) |
| status | O estado de uma ligação de ponto final privado | "Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório) |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a aprovisionar | int |
| name | Nome do SKU. | 'S1' |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar um Hub IOT e um simulador do Ubuntu Edge |
Este modelo cria um hub IOT e um simulador de periferia do Ubuntu da Máquina Virtual. |
| Criar um Serviço de Aprovisionamento de Dispositivos Hub IoT |
Este modelo permite-lhe criar um hub IoT e um Serviço de Aprovisionamento de Dispositivos Hub IoT e associar os dois serviços. |
Definição de recurso de modelo do ARM
O tipo de recurso provisioningServices pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2021-10-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "S1"
},
"etag": "string",
"properties": {
"allocationPolicy": "string",
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"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
provisioningServices
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Devices/provisioningServices" |
| apiVersion | A versão da API de recursos | '2021-10-15' |
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. Termine com alfanumérico. |
| localização | A localização do recurso. | cadeia (obrigatório) |
| etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | Informações de SKU para um Serviço de aprovisionamento. | IotDpsSkuInfo (obrigatório) |
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| propriedades | Propriedades específicas do serviço para um serviço de aprovisionamento | IotDpsPropertiesDescription (obrigatório) |
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a utilizar por este serviço de aprovisionamento. | "GeoLatency" 'Hashed' "Estático" |
| authorizationPolicies | Lista de chaves de autorização para um serviço de aprovisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
| enableDataResidency | Opcional. Indica se a instância do DPS Data Residency ativada, removendo a recuperação após desastre entre pares geográficos. |
bool |
| iotHubs | Lista de hubs IoT associados a este serviço de aprovisionamento. | IotHubDefinitionDescription[] |
| ipFilterRules | As regras de filtro de IP. | IpFilterRule[] |
| privateEndpointConnections | Ligações de ponto final privados criadas neste IotHub | PrivateEndpointConnection[] |
| provisioningState | O estado de aprovisionamento do ARM do serviço de aprovisionamento. | string |
| publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | "Desativado" "Ativado" |
| state | Estado atual do serviço de aprovisionamento. | "Ativar" "Ativação Falhada" "Ativo" "Eliminado" "A eliminar" "Eliminação Falhada" "Ativação Pós-falha" "Falha na Ativação Pós-falha" 'Retomar' "Suspenso" 'Suspender' "Transição" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS principal. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS principal. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a aplicar para um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | bool |
| connectionString | Cadeia de ligação do hub IoT. | cadeia (obrigatório) |
| localização | Região arm do hub IoT. | cadeia (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| action | A ação pretendida para pedidos capturados por esta regra. | "Aceitar" "Rejeitar" (obrigatório) |
| filterName | O nome da regra de filtro IP. | cadeia (obrigatório) |
| ipMask | Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra. | cadeia (obrigatório) |
| destino | Destino para pedidos capturados por esta regra. | "todos" "deviceApi" "serviceApi" |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Nome | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto final privado de uma ligação de ponto final privado | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma ligação de ponto final privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma ligação de ponto final privado | string |
| descrição | A descrição do estado atual de uma ligação de ponto final privado | cadeia (obrigatório) |
| status | O estado de uma ligação de ponto final privado | "Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório) |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a aprovisionar | int |
| name | Nome do SKU. | 'S1' |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar um Hub IOT e um simulador do Ubuntu Edge |
Este modelo cria um hub IOT e um simulador de periferia do Ubuntu da Máquina Virtual. |
| Criar um Serviço de Aprovisionamento de Dispositivos Hub IoT |
Este modelo permite-lhe criar um hub IoT e um Serviço de Aprovisionamento de Dispositivos Hub IoT e associar os dois serviços. |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso provisioningServices pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2021-10-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
allocationPolicy = "string"
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
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 = "S1"
}
etag = "string"
})
}
Valores de propriedade
provisioningServices
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Devices/provisioningServices@2021-10-15" |
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. Termine com alfanumérico. |
| localização | A localização do recurso. | cadeia (obrigatório) |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
| sku | Informações de SKU para um Serviço de aprovisionamento. | IotDpsSkuInfo (obrigatório) |
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| propriedades | Propriedades específicas do serviço para um serviço de aprovisionamento | IotDpsPropertiesDescription (obrigatório) |
IotDpsPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationPolicy | Política de alocação a utilizar por este serviço de aprovisionamento. | "GeoLatency" "Hashed" "Estático" |
| authorizationPolicies | Lista de chaves de autorização para um serviço de aprovisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
| enableDataResidency | Opcional. Indica se a instância do DPS Data Residency ativada, removendo a recuperação após desastre entre pares geográficos. |
bool |
| iotHubs | Lista de hubs IoT associados a este serviço de aprovisionamento. | IotHubDefinitionDescription[] |
| ipFilterRules | As regras de filtro de IP. | IpFilterRule[] |
| privateEndpointConnections | Ligações de ponto final privado criadas neste IotHub | PrivateEndpointConnection[] |
| provisioningState | O estado de aprovisionamento do ARM do serviço de aprovisionamento. | string |
| publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | "Desativado" "Ativado" |
| state | Estado atual do serviço de aprovisionamento. | "A ativar" "Ativação Falhada" "Ativo" "Eliminado" "A eliminar" "Falha na Eliminação" "Ativação Pós-falha" "Falha na Ativação Pós-falha" "A retomar" "Suspenso" "A suspender" "Em transição" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
| Nome | Descrição | Valor |
|---|---|---|
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS primária. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
| keyName | Nome da chave. | cadeia (obrigatório) |
| primaryKey | Valor da chave SAS primária. | string |
| direitos | Direitos que esta chave tem. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (obrigatório) |
| secondaryKey | Valor da chave SAS secundária. | string |
IotHubDefinitionDescription
| Nome | Descrição | Valor |
|---|---|---|
| allocationWeight | peso a aplicar para um determinado iot h. | int |
| applyAllocationPolicy | sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. | bool |
| connectionString | Cadeia de ligação do hub IoT. | cadeia (obrigatório) |
| localização | Região arm do hub IoT. | cadeia (obrigatório) |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| action | A ação pretendida para pedidos capturados por esta regra. | "Aceitar" "Rejeitar" (obrigatório) |
| filterName | O nome da regra de filtro ip. | cadeia (obrigatório) |
| ipMask | Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra. | cadeia (obrigatório) |
| destino | Destino para pedidos capturados por esta regra. | "todos" "deviceApi" "serviceApi" |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Nome | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto final privado de uma ligação de ponto final privado | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma ligação de ponto final privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma ligação de ponto final privado | string |
| descrição | A descrição do estado atual de uma ligação de ponto final privado | cadeia (obrigatório) |
| status | O estado de uma ligação de ponto final privado | "Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório) |
IotDpsSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades a aprovisionar | int |
| name | Nome do SKU. | "S1" |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários