Provisionamento microsoft.devicesServices 2020-01-01

Artigo
04/03/2024

Definição de recurso do Bicep

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

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 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@2020-01-01' = {
  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'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: '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[]
ipFilterRules	As regras de filtro IP.	IpFilterRule[]
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 iot h.	INT
applyAllocationPolicy	sinalizador para aplicar allocationPolicy ou não para um determinado hub iot.	bool
connectionString	Cadeia de conexão og o hub IoT.	cadeia de caracteres (obrigatório)
local	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.	'Accept' '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)
destino	Destino para solicitações capturadas por essa regra.	'all' 'deviceApi' 'serviceApi'

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	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	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:

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 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",
  "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"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "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	'2020-01-01'
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[]
ipFilterRules	As regras de filtro IP.	IpFilterRule[]
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 iot h.	INT
applyAllocationPolicy	sinalizador para aplicar allocationPolicy ou não para um determinado hub iot.	bool
connectionString	Cadeia de conexão, por exemplo, o Hub IoT.	cadeia de caracteres (obrigatório)
local	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.	'Accept' '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)
destino	Destino para solicitações capturadas por essa regra.	'all' 'deviceApi' 'serviceApi'

IotDpsSkuInfo

Nome	Descrição	Valor
ALOCADA	O número de unidades a serem provisionados	INT
name	Nome da 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	Este modelo cria um Hub IOT e um simulador de borda do Ubuntu da Máquina Virtual.
Criar um serviço de provisionamento de dispositivos Hub IoT	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.

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

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

Grupos de recursos

Para obter uma lista das 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 seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-01-01"
  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"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "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@2020-01-01"
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 3-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 for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção de 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[]
ipFilterRules	As regras de filtro IP.	IpFilterRule[]
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 iot h.	INT
applyAllocationPolicy	sinalizador para aplicar allocationPolicy ou não para um determinado hub iot.	bool
connectionString	Cadeia de conexão og o hub IoT.	cadeia de caracteres (obrigatório)
local	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" "Rejeitar" (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)
destino	Destino para solicitações capturadas por essa regra.	"all" "deviceApi" "serviceApi"

IotDpsSkuInfo

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

Compartilhar via

Provisionamento microsoft.devicesServices 2020-01-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Comentários

Recursos adicionais