Microsoft.Devices provisioningServices 2022-02-05
O tipo de recurso provisioningServices pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
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'
}
}
Designação | Descrição | Valor |
---|---|---|
alocaçãoPolítica | Política de alocação a ser usada por este serviço de provisionamento. | 'GeoLatência' 'Hashed' 'Estática' |
authorizationPolíticas | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescrição[] |
enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastres entre pares geográficos. |
Bool |
iotHubs | Lista de hubs IoT associados a este serviço de provisionamento. | IotHubDefinitionDescription[] |
ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
provisionamentoEstado | O estado de provisionamento ARM do serviço de provisionamento. | string |
publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
Estado | Estado atual do serviço de provisionamento. | 'Ativação' 'Ativação falhou' 'Ativo' «Suprimido» 'Eliminação' 'Falha na exclusão' 'FailingOver' 'FailoverFailed' 'Retomada' 'Suspenso' 'Suspensão' 'Transição' |
Designação | Descrição | Valor |
---|---|---|
capacidade | O número de unidades a provisionar | Int |
Designação | Nome Sku. | «S1» |
Designação | Descrição | Valor |
---|---|---|
alocaçãoPeso | peso para aplicar para 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. | string (obrigatório) |
Localização | Região ARM do hub IoT. | string (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
filterName | O nome da regra de filtro IP. | string (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
público-alvo | Destino para solicitações capturadas por esta regra. | 'todos' 'deviceApi' 'ServiceApi' |
Designação | Descrição | Valor |
---|---|---|
etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também deve ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
Localização | A localização do recurso. | string (obrigatório) |
Designação | O nome do recurso | string (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) |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
Nome da chave | Nome da chave. | string (obrigatório) |
primárioChave | Valor da chave SAS primária. | string |
Direitos | Direitos que esta chave tem. | 'DeviceConnect' 'InscriçãoLer' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
secundário | Valor da chave SAS secundária. | string |
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 Dispositivo do Hub IoT | Este modelo permite criar um hub IoT e um Serviço de Provisionamento de Dispositivo do Hub IoT e vincular os dois serviços. |
O tipo de recurso provisioningServices pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte JSON ao seu 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"
}
}
Designação | Descrição | Valor |
---|---|---|
alocaçãoPolítica | Política de alocação a ser usada por este serviço de provisionamento. | 'GeoLatência' 'Hashed' 'Estática' |
authorizationPolíticas | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescrição[] |
enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastres entre pares geográficos. |
Bool |
iotHubs | Lista de hubs IoT associados a este serviço de provisionamento. | IotHubDefinitionDescription[] |
ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
provisionamentoEstado | O estado de provisionamento ARM do serviço de provisionamento. | string |
publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
Estado | Estado atual do serviço de provisionamento. | 'Ativação' 'Ativação falhou' 'Ativo' «Suprimido» 'Eliminação' 'Falha na exclusão' 'FailingOver' 'FailoverFailed' 'Retomada' 'Suspenso' 'Suspensão' 'Transição' |
Designação | Descrição | Valor |
---|---|---|
capacidade | O número de unidades a provisionar | Int |
Designação | Nome Sku. | «S1» |
Designação | Descrição | Valor |
---|---|---|
alocaçãoPeso | peso para aplicar para 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. | string (obrigatório) |
Localização | Região ARM do hub IoT. | string (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
filterName | O nome da regra de filtro IP. | string (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
público-alvo | Destino para solicitações capturadas por esta regra. | 'todos' 'deviceApi' 'ServiceApi' |
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2022-02-05' |
etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também deve ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
Localização | A localização do recurso. | string (obrigatório) |
Designação | O nome do recurso | string (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) |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
tipo | O tipo de recurso | 'Microsoft.Devices/provisioningServices' |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
Nome da chave | Nome da chave. | string (obrigatório) |
primárioChave | Valor da chave SAS primária. | string |
Direitos | Direitos que esta chave tem. | 'DeviceConnect' 'InscriçãoLer' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
secundário | Valor da chave SAS secundária. | string |
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Crie um Hub IOT e um simulador de borda do Ubuntu |
Este modelo cria um Hub IOT e um simulador de borda Ubuntu de máquina virtual. |
Criar um Serviço de Provisionamento de Dispositivo do Hub IoT |
Este modelo permite criar um hub IoT e um Serviço de Provisionamento de Dispositivo do Hub IoT e vincular os dois serviços. |
O tipo de recurso provisioningServices pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte Terraform 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"
}
})
}
Designação | Descrição | Valor |
---|---|---|
alocaçãoPolítica | Política de alocação a ser usada por este serviço de provisionamento. | 'GeoLatência' 'Hashed' 'Estática' |
authorizationPolíticas | Lista de chaves de autorização para um serviço de provisionamento. | SharedAccessSignatureAuthorizationRuleAccessRightsDescrição[] |
enableDataResidency | Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastres entre pares geográficos. |
Bool |
iotHubs | Lista de hubs IoT associados a este serviço de provisionamento. | IotHubDefinitionDescription[] |
ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
provisionamentoEstado | O estado de provisionamento ARM do serviço de provisionamento. | string |
publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
Estado | Estado atual do serviço de provisionamento. | 'Ativação' 'Ativação falhou' 'Ativo' «Suprimido» 'Eliminação' 'Falha na exclusão' 'FailingOver' 'FailoverFailed' 'Retomada' 'Suspenso' 'Suspensão' 'Transição' |
Designação | Descrição | Valor |
---|---|---|
capacidade | O número de unidades a provisionar | Int |
Designação | Nome Sku. | «S1» |
Designação | Descrição | Valor |
---|---|---|
alocaçãoPeso | peso para aplicar para 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. | string (obrigatório) |
Localização | Região ARM do hub IoT. | string (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
filterName | O nome da regra de filtro IP. | string (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
público-alvo | Destino para solicitações capturadas por esta regra. | 'todos' 'deviceApi' 'ServiceApi' |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
Designação | Descrição | Valor |
---|---|---|
açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Designação | Descrição | Valor |
---|
Designação | Descrição | Valor |
---|---|---|
Nome da chave | Nome da chave. | string (obrigatório) |
primárioChave | Valor da chave SAS primária. | string |
Direitos | Direitos que esta chave tem. | 'DeviceConnect' 'InscriçãoLer' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obrigatório) |
secundário | Valor da chave SAS secundária. | string |