Microsoft.Devices provisioningServices 2018-01-22

Artigo
04/03/2024

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@2018-01-22' = {
  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 (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...[]
iotHubs	Lista de hubs IoT associados a este serviço de aprovisionamento.	IotHubDefinitionDescription[]
provisioningState	O estado de aprovisionamento do ARM do serviço de aprovisionamento.	string
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 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 og o hub IoT.	cadeia (obrigatório)
localização	Região arm do hub IoT.	cadeia (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 de periferia do Ubuntu	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 Hub IoT Serviço de Aprovisionamento de Dispositivos e associar os dois serviços.

Definição de recurso do modelo arm

O tipo de recurso provisioningServices pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das 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": "2018-01-22",
  "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	'2018-01-22'
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. Terminar 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...[]
iotHubs	Lista de hubs IoT associados a este serviço de aprovisionamento.	IotHubDefinitionDescription[]
provisioningState	O estado de aprovisionamento do ARM do serviço de aprovisionamento.	string
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 og o hub IoT.	cadeia (obrigatório)
localização	Região arm do hub IoT.	cadeia (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 Hub IoT Serviço de Aprovisionamento de Dispositivos e associar os dois serviços.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso provisioningServices pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista das 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@2018-01-22"
  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@2018-01-22"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. Terminar 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...[]
iotHubs	Lista de hubs IoT associados a este serviço de aprovisionamento.	IotHubDefinitionDescription[]
provisioningState	O estado de aprovisionamento do ARM do serviço de aprovisionamento.	string
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 og o hub IoT.	cadeia (obrigatório)
localização	Região arm do hub IoT.	cadeia (obrigatório)

IotDpsSkuInfo

Nome	Descrição	Valor
capacidade	O número de unidades a aprovisionar	int
name	Nome do SKU.	"S1"

Partilhar via

Microsoft.Devices provisioningServices 2018-01-22

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IotDpsSkuInfo

Modelos de início rápido

Definição de recurso do modelo arm

Formato do recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IotDpsSkuInfo

Modelos de início rápido

Definição de recurso terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IotDpsSkuInfo

Comentários

Recursos adicionais