Compartilhar via

Microsoft.Devices provisioningServices 01/01/2020

Definição de recurso do Bicep

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

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@2020-01-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.Devices/serviços de provisionamento

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

Descrição das Propriedades do IotDps

Nome Descrição Valor
allocationPolicy Política de alocação a ser usada por esse serviço de provisionamento. 'GeoLatência'
'Hashed'
'Estático'
autorizaçãoPolíticas Lista de chaves de autorização para um serviço de provisionamento. SharedAccessSignatureAuthorizationRuleAccessRightsDescription
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription []
ipFilterRules As regras de filtro IP. IpFilterRule []
estado de provisionamento O estado de provisionamento do ARM do serviço de provisionamento. corda
estado Estado atual do serviço de provisionamento. 'Ativando'
'Falha na ativação'
'Ativo'
'Excluído'
'Excluindo'
'Falha na exclusão'
'FailOver'
'Falha no failover'
'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
cadeia de caracteres de conexão Cadeia de conexão og o hub IoT. cadeia de caracteres (obrigatório)
localização Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

Regra de filtro de IP

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)
Máscara de ip 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. 'Todos'
'deviceApi'
'serviceApi'

Tags de recursos

Nome Descrição Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome Descrição Valor
nome_chave Nome da chave. cadeia de caracteres (obrigatório)
chave primária Valor da chave SAS primária. corda
direitos Direitos que essa chave tem. 'Conexão de Dispositivo'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obrigatório)
secondaryKey Valor de chave SAS secundário. corda

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar 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:

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": "2020-01-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.Devices/serviços de provisionamento

Nome Descrição Valor
apiVersion A versão da API '2020-01-01'
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'

Descrição das Propriedades do IotDps

Nome Descrição Valor
allocationPolicy Política de alocação a ser usada por esse serviço de provisionamento. 'GeoLatência'
'Hashed'
'Estático'
autorizaçãoPolíticas Lista de chaves de autorização para um serviço de provisionamento. SharedAccessSignatureAuthorizationRuleAccessRightsDescription
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription []
ipFilterRules As regras de filtro IP. IpFilterRule []
estado de provisionamento O estado de provisionamento do ARM do serviço de provisionamento. corda
estado Estado atual do serviço de provisionamento. 'Ativando'
'Falha na ativação'
'Ativo'
'Excluído'
'Excluindo'
'Falha na exclusão'
'FailOver'
'Falha no failover'
'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
cadeia de caracteres de conexão Cadeia de conexão og o hub IoT. cadeia de caracteres (obrigatório)
localização Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

Regra de filtro de IP

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)
Máscara de ip 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. 'Todos'
'deviceApi'
'serviceApi'

Tags de recursos

Nome Descrição Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome Descrição Valor
nome_chave Nome da chave. cadeia de caracteres (obrigatório)
chave primária Valor da chave SAS primária. corda
direitos Direitos que essa chave tem. 'Conexão de Dispositivo'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obrigatório)
secondaryKey Valor de chave SAS secundário. corda

Exemplos de uso

Modelos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
Criar um Hub IOT e um simulador de borda do Ubuntu

Implantar no Azure 		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

Implantar no Azure 		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@2020-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

Valores de propriedade

Microsoft.Devices/serviços de provisionamento

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.
tipo O tipo de recurso "Microsoft.Devices/provisioningServices@2020-01-01"

Descrição das Propriedades do IotDps

Nome Descrição Valor
allocationPolicy Política de alocação a ser usada por esse serviço de provisionamento. 'GeoLatência'
'Hashed'
'Estático'
autorizaçãoPolíticas Lista de chaves de autorização para um serviço de provisionamento. SharedAccessSignatureAuthorizationRuleAccessRightsDescription
iotHubs Lista de hubs IoT associados a esse serviço de provisionamento. IotHubDefinitionDescription []
ipFilterRules As regras de filtro IP. IpFilterRule []
estado de provisionamento O estado de provisionamento do ARM do serviço de provisionamento. corda
estado Estado atual do serviço de provisionamento. 'Ativando'
'Falha na ativação'
'Ativo'
'Excluído'
'Excluindo'
'Falha na exclusão'
'FailOver'
'Falha no failover'
'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
cadeia de caracteres de conexão Cadeia de conexão og o hub IoT. cadeia de caracteres (obrigatório)
localização Região do ARM do hub IoT. cadeia de caracteres (obrigatório)

Regra de filtro de IP

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)
Máscara de ip 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. 'Todos'
'deviceApi'
'serviceApi'

Tags de recursos

Nome Descrição Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome Descrição Valor
nome_chave Nome da chave. cadeia de caracteres (obrigatório)
chave primária Valor da chave SAS primária. corda
direitos Direitos que essa chave tem. 'Conexão de Dispositivo'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obrigatório)
secondaryKey Valor de chave SAS secundário. corda