Partilhar via


Contas Microsoft.DeviceUpdate

Definição de recursos do bíceps

O tipo de recurso de contas pode ser implantado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.DeviceUpdate/accounts, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DeviceUpdate/accounts@2023-07-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      keyVaultKeyUri: 'string'
      userAssignedIdentity: 'string'
    }
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    sku: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.DeviceUpdate/contas

Designação Descrição Valor
identidade O tipo de identidade usado para o recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 24
Padrão = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obrigatório)
propriedades Propriedades da conta de Atualização de Dispositivo. Propriedades da Conta
âmbito Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Propriedades da Conta

Designação Descrição Valor
cifragem Criptografia CMK em propriedades de repouso de criptografia
privateEndpointConnections Lista de conexões de ponto de extremidade privadas associadas à conta. PrivateEndpointConnection []
acesso à rede pública Se o acesso à rede pública é permitido ou não para a conta. 'Desativado'
'Habilitado'
SKU Sku de atualização de dispositivo 'Grátis'
'Padrão'

Encriptação

Designação Descrição Valor
keyVaultKeyUri O URI do cofre de chaves cadeia (de caracteres)
identidade atribuída pelo usuário O resourceId completo da identidade atribuída ao usuário a ser usado para acesso ao cofre de chaves. A identidade também deve ser atribuída à Conta cadeia (de caracteres)

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

PrivateEndpoint

Designação Descrição Valor

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do recurso. PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Designação Descrição Valor
IDs de grupo Matriz de IDs de grupo. string[]
privateEndpoint O recurso do ponto final privado. PrivateEndpoint
privateLinkServiceConnectionState Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços. PrivateLinkServiceConnectionState (obrigatório)

PrivateLinkServiceConnectionState

Designação Descrição Valor
açõesObrigatório Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor. cadeia (de caracteres)
Descrição O motivo da aprovação/rejeição da ligação. cadeia (de caracteres)
estado Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. 'Aprovado'
'Pendente'
'Rejeitado'

TrackedResourceTags

Designação Descrição Valor

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Exemplos de início rápido do Azure

Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
Criar Atualização de Dispositivo para a conta do Hub IoT Este modelo cria uma conta que fornece registro DNS público e permite fazer chamadas de API REST para o Plano de Dados. Em seguida, o usuário precisa criar uma instância sob a conta e vinculá-la a um Hub IoT para começar a usar o serviço.
Criar atualização de dispositivo para a conta do Hub IoT, instância, do Hub IoT Esse modelo cria uma conta e uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, rotas e grupo de consumidores necessários.

Definição de recurso de modelo ARM

O tipo de recurso de contas pode ser implantado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.DeviceUpdate/accounts, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DeviceUpdate/accounts",
  "apiVersion": "2023-07-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "encryption": {
      "keyVaultKeyUri": "string",
      "userAssignedIdentity": "string"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "sku": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.DeviceUpdate/contas

Designação Descrição Valor
Versão da API A versão api '2023-07-01'
identidade O tipo de identidade usado para o recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 24
Padrão = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obrigatório)
propriedades Propriedades da conta de Atualização de Dispositivo. Propriedades da Conta
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DeviceUpdate/contas'

Propriedades da Conta

Designação Descrição Valor
cifragem Criptografia CMK em propriedades de repouso de criptografia
privateEndpointConnections Lista de conexões de ponto de extremidade privadas associadas à conta. PrivateEndpointConnection []
acesso à rede pública Se o acesso à rede pública é permitido ou não para a conta. 'Desativado'
'Habilitado'
SKU Sku de atualização de dispositivo 'Grátis'
'Padrão'

Encriptação

Designação Descrição Valor
keyVaultKeyUri O URI do cofre de chaves cadeia (de caracteres)
identidade atribuída pelo usuário O resourceId completo da identidade atribuída ao usuário a ser usado para acesso ao cofre de chaves. A identidade também deve ser atribuída à Conta cadeia (de caracteres)

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

PrivateEndpoint

Designação Descrição Valor

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do recurso. PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Designação Descrição Valor
IDs de grupo Matriz de IDs de grupo. string[]
privateEndpoint O recurso do ponto final privado. PrivateEndpoint
privateLinkServiceConnectionState Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços. PrivateLinkServiceConnectionState (obrigatório)

PrivateLinkServiceConnectionState

Designação Descrição Valor
açõesObrigatório Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor. cadeia (de caracteres)
Descrição O motivo da aprovação/rejeição da ligação. cadeia (de caracteres)
estado Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. 'Aprovado'
'Pendente'
'Rejeitado'

TrackedResourceTags

Designação Descrição Valor

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.

Modelo Descrição
Criar Atualização de Dispositivo para a conta do Hub IoT

Implantar no Azure
Este modelo cria uma conta que fornece registro DNS público e permite fazer chamadas de API REST para o Plano de Dados. Em seguida, o usuário precisa criar uma instância sob a conta e vinculá-la a um Hub IoT para começar a usar o serviço.
Criar atualização de dispositivo para a conta do Hub IoT, instância, do Hub IoT

Implantar no Azure
Esse modelo cria uma conta e uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, rotas e grupo de consumidores necessários.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de contas pode ser implantado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.DeviceUpdate/accounts, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceUpdate/accounts@2023-07-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      encryption = {
        keyVaultKeyUri = "string"
        userAssignedIdentity = "string"
      }
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      sku = "string"
    }
  }
}

Valores de propriedade

Microsoft.DeviceUpdate/contas

Designação Descrição Valor
identidade O tipo de identidade usado para o recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 24
Padrão = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades Propriedades da conta de Atualização de Dispositivo. Propriedades da Conta
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DeviceUpdate/accounts@2023-07-01"

Propriedades da Conta

Designação Descrição Valor
cifragem Criptografia CMK em propriedades de repouso de criptografia
privateEndpointConnections Lista de conexões de ponto de extremidade privadas associadas à conta. PrivateEndpointConnection []
acesso à rede pública Se o acesso à rede pública é permitido ou não para a conta. 'Desativado'
'Habilitado'
SKU Sku de atualização de dispositivo 'Grátis'
'Padrão'

Encriptação

Designação Descrição Valor
keyVaultKeyUri O URI do cofre de chaves cadeia (de caracteres)
identidade atribuída pelo usuário O resourceId completo da identidade atribuída ao usuário a ser usado para acesso ao cofre de chaves. A identidade também deve ser atribuída à Conta cadeia (de caracteres)

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

PrivateEndpoint

Designação Descrição Valor

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do recurso. PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Designação Descrição Valor
IDs de grupo Matriz de IDs de grupo. string[]
privateEndpoint O recurso do ponto final privado. PrivateEndpoint
privateLinkServiceConnectionState Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços. PrivateLinkServiceConnectionState (obrigatório)

PrivateLinkServiceConnectionState

Designação Descrição Valor
açõesObrigatório Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor. cadeia (de caracteres)
Descrição O motivo da aprovação/rejeição da ligação. cadeia (de caracteres)
estado Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. 'Aprovado'
'Pendente'
'Rejeitado'

TrackedResourceTags

Designação Descrição Valor

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação da Conta de Atualização de Dispositivo do Hub IoT.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "account" {
  type      = "Microsoft.DeviceUpdate/accounts@2022-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      publicNetworkAccess = "Enabled"
      sku                 = "Standard"
    }

  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}