Compartilhar via


Provisionamento microsoft.devicesServices 2017-11-15

Definição de recurso do Bicep

O tipo de recurso provisioningServices pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Devices/provisioningServices, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.Devices/provisioningServices@2017-11-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'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
}

Valores de propriedade

provisioningServices

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 64

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Termine com caractere alfanumérico.
local O local do recurso. cadeia de caracteres (obrigatório)
marcas As marcas do recurso. Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
sku Informações de SKU para um serviço de provisionamento. IotDpsSkuInfo (obrigatório)
etag O campo Etag não é necessário. Se ele for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. string
properties Propriedades específicas do serviço para um serviço de provisionamento IotDpsPropertiesDescription (obrigatório)

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. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription[]
provisioningState O estado de provisionamento do ARM do serviço de provisionamento. string
state Estado atual do serviço de provisionamento. 'Ativando'
'ActivationFailed'
'Ativo'
'Excluído'
'Excluindo'
'DeletionFailed'
'FailOver'
'FailoverFailed'
'Resumindo'
'Suspenso'
'Suspendendo'
'Transição'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nome Descrição Valor
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa chave tem. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obrigatório)
secondaryKey Valor da chave SAS secundária. string
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa 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 ser aplicado a um determinado hub IoT. 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)
local Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

IotDpsSkuInfo

Nome Descrição Valor
ALOCADA O número de unidades a serem provisionados INT
name Nome do SKU. 'S1'

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

Implantar no Azure
Este modelo cria um Hub IOT e um simulador de borda do Ubuntu da Máquina Virtual.
Criar um serviço de provisionamento de dispositivo Hub IoT

Implantar no Azure
Esse modelo permite que você crie um hub IoT e um Hub IoT Serviço de Provisionamento de Dispositivos 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 direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte 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": "2017-11-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"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "provisioningState": "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 '2017-11-15'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 64

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Termine com caractere alfanumérico.
local O local do recurso. cadeia de caracteres (obrigatório)
marcas As marcas do recurso. Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
sku Informações de SKU para um serviço de provisionamento. IotDpsSkuInfo (obrigatório)
etag O campo Etag não é necessário. Se ele for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. string
properties Propriedades específicas do serviço para um serviço de provisionamento IotDpsPropertiesDescription (obrigatório)

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. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription[]
provisioningState O estado de provisionamento do ARM do serviço de provisionamento. string
state Estado atual do serviço de provisionamento. 'Ativando'
'ActivationFailed'
'Ativo'
'Excluído'
'Excluindo'
'DeletionFailed'
'FailOver'
'FailoverFailed'
'Resumindo'
'Suspenso'
'Suspendendo'
'Transição'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nome Descrição Valor
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa chave tem. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obrigatório)
secondaryKey Valor da chave SAS secundária. string
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa 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 ser aplicado a um determinado hub IoT. 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)
local Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

IotDpsSkuInfo

Nome Descrição Valor
ALOCADA O número de unidades a serem provisionados INT
name Nome do SKU. 'S1'

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

Implantar no Azure
Este modelo cria um Hub IOT e um simulador de borda do Ubuntu da Máquina Virtual.
Criar um serviço de provisionamento de dispositivo Hub IoT

Implantar no Azure
Esse modelo permite que você crie um hub IoT e um Hub IoT Serviço de Provisionamento de Dispositivos e vincule os dois serviços juntos.

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso provisioningServices pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Devices/provisioningServices, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2017-11-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"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      provisioningState = "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@2017-11-15"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 64

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Termine com caractere alfanumérico.
local O local do recurso. cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas As marcas do recurso. Dicionário de nomes e valores de marcas.
sku Informações de SKU para um serviço de provisionamento. IotDpsSkuInfo (obrigatório)
etag O campo Etag não é necessário. Se ele for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. string
properties Propriedades específicas do serviço para um serviço de provisionamento IotDpsPropertiesDescription (obrigatório)

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. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription[]
provisioningState O estado de provisionamento do ARM do serviço de provisionamento. string
state Estado atual do serviço de provisionamento. "Ativando"
"ActivationFailed"
"Ativo"
"Excluído"
"Excluindo"
"DeletionFailed"
"FailOver"
"FailoverFailed"
"Resumindo"
"Suspenso"
"Suspendendo"
"Transição"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nome Descrição Valor
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa chave tem. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (obrigatório)
secondaryKey Valor da chave SAS secundária. string
keyName Nome da chave. cadeia de caracteres (obrigatório)
primaryKey Valor da chave SAS primária. string
direitos Direitos que essa 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 ser aplicado a um determinado hub IoT. 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)
local Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

IotDpsSkuInfo

Nome Descrição Valor
ALOCADA O número de unidades a serem provisionados INT
name Nome do SKU. "S1"