Partager via


Comptes Microsoft.DeviceUpdate

Définition de ressource Bicep

Le type de ressource de comptes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DeviceUpdate/accounts, ajoutez le bicep suivant à votre modèle.

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'
  }
}

Valeurs de propriété

Microsoft.DeviceUpdate/accounts

Nom Descriptif Valeur
identité Type d’identité utilisé pour la ressource. ManagedServiceIdentity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obligatoire)
Propriétés Propriétés du compte Device Update. ComptePropriétés
portée Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension .
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ComptePropriétés

Nom Descriptif Valeur
chiffrement Chiffrement CMK au repos des propriétés chiffrement
privateEndpointConnections Liste des connexions de point de terminaison privé associées au compte. PrivateEndpointConnection[]
publicNetworkAccess Indique si l’accès au réseau public est autorisé pour le compte. 'Désactivé'
'Activé'
Sku Référence de mise à jour de l’appareil « Gratuit »
« Standard »

Chiffrement

Nom Descriptif Valeur
keyVaultKeyUri URI du coffre de clés corde
userAssignedIdentity Id de ressource complet de l’identité affectée par l’utilisateur à utiliser pour l’accès au coffre de clés. L’identité doit également être affectée au compte corde

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. UserAssignedIdentities

PrivateEndpoint

Nom Descriptif Valeur

PrivateEndpointConnection

Nom Descriptif Valeur
Propriétés Propriétés de ressource. PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom Descriptif Valeur
identifiants de groupe Tableau d’ID de groupe. chaîne de caractères[]
privateEndpoint Ressource du point de terminaison privé. PrivateEndpoint
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom Descriptif Valeur
actionsObligatoire Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. corde
descriptif Raison de l’approbation/rejet de la connexion. corde
statut Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. 'Approuvé'
'En attente'
'Rejeté'

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentities

Nom Descriptif Valeur

userAssignedIdentity

Nom Descriptif Valeur

Exemples d’utilisation

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
créer une mise à jour d’appareil pour le compte IoT Hub Ce modèle crée un compte qui fournit un enregistrement DNS public et permet d’effectuer des appels d’API REST au plan de données. L’utilisateur doit ensuite créer une instance sous le compte et la lier à un Hub IoT pour commencer à utiliser le service.
Créer une mise à jour d’appareil pour un compte IoT Hub, une instance, un IoT Hub Ce modèle crée un compte, une instance et un hub pour lier l’instance. Il configure le hub avec les stratégies d’accès, les itinéraires et le groupe de consommateurs nécessaires.

Définition de ressource de modèle ARM

Le type de ressource de comptes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DeviceUpdate/accounts, ajoutez le code JSON suivant à votre modèle.

{
  "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"
  }
}

Valeurs de propriété

Microsoft.DeviceUpdate/accounts

Nom Descriptif Valeur
apiVersion Version de l’API '2023-07-01'
identité Type d’identité utilisé pour la ressource. ManagedServiceIdentity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obligatoire)
Propriétés Propriétés du compte Device Update. ComptePropriétés
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DeviceUpdate/accounts'

ComptePropriétés

Nom Descriptif Valeur
chiffrement Chiffrement CMK au repos des propriétés chiffrement
privateEndpointConnections Liste des connexions de point de terminaison privé associées au compte. PrivateEndpointConnection[]
publicNetworkAccess Indique si l’accès au réseau public est autorisé pour le compte. 'Désactivé'
'Activé'
Sku Référence de mise à jour de l’appareil « Gratuit »
« Standard »

Chiffrement

Nom Descriptif Valeur
keyVaultKeyUri URI du coffre de clés corde
userAssignedIdentity Id de ressource complet de l’identité affectée par l’utilisateur à utiliser pour l’accès au coffre de clés. L’identité doit également être affectée au compte corde

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. UserAssignedIdentities

PrivateEndpoint

Nom Descriptif Valeur

PrivateEndpointConnection

Nom Descriptif Valeur
Propriétés Propriétés de ressource. PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom Descriptif Valeur
identifiants de groupe Tableau d’ID de groupe. chaîne de caractères[]
privateEndpoint Ressource du point de terminaison privé. PrivateEndpoint
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom Descriptif Valeur
actionsObligatoire Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. corde
descriptif Raison de l’approbation/rejet de la connexion. corde
statut Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. 'Approuvé'
'En attente'
'Rejeté'

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentities

Nom Descriptif Valeur

userAssignedIdentity

Nom Descriptif Valeur

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
créer une mise à jour d’appareil pour le compte IoT Hub

Déployer sur Azure
Ce modèle crée un compte qui fournit un enregistrement DNS public et permet d’effectuer des appels d’API REST au plan de données. L’utilisateur doit ensuite créer une instance sous le compte et la lier à un Hub IoT pour commencer à utiliser le service.
Créer une mise à jour d’appareil pour un compte IoT Hub, une instance, un IoT Hub

Déployer sur Azure
Ce modèle crée un compte, une instance et un hub pour lier l’instance. Il configure le hub avec les stratégies d’accès, les itinéraires et le groupe de consommateurs nécessaires.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de comptes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DeviceUpdate/accounts, ajoutez terraform suivant à votre modèle.

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"
    }
  }
}

Valeurs de propriété

Microsoft.DeviceUpdate/accounts

Nom Descriptif Valeur
identité Type d’identité utilisé pour la ressource. ManagedServiceIdentity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. chaîne (obligatoire)
Propriétés Propriétés du compte Device Update. ComptePropriétés
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DeviceUpdate/accounts@2023-07-01 »

ComptePropriétés

Nom Descriptif Valeur
chiffrement Chiffrement CMK au repos des propriétés chiffrement
privateEndpointConnections Liste des connexions de point de terminaison privé associées au compte. PrivateEndpointConnection[]
publicNetworkAccess Indique si l’accès au réseau public est autorisé pour le compte. 'Désactivé'
'Activé'
Sku Référence de mise à jour de l’appareil « Gratuit »
« Standard »

Chiffrement

Nom Descriptif Valeur
keyVaultKeyUri URI du coffre de clés corde
userAssignedIdentity Id de ressource complet de l’identité affectée par l’utilisateur à utiliser pour l’accès au coffre de clés. L’identité doit également être affectée au compte corde

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. UserAssignedIdentities

PrivateEndpoint

Nom Descriptif Valeur

PrivateEndpointConnection

Nom Descriptif Valeur
Propriétés Propriétés de ressource. PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom Descriptif Valeur
identifiants de groupe Tableau d’ID de groupe. chaîne de caractères[]
privateEndpoint Ressource du point de terminaison privé. PrivateEndpoint
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom Descriptif Valeur
actionsObligatoire Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. corde
descriptif Raison de l’approbation/rejet de la connexion. corde
statut Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. 'Approuvé'
'En attente'
'Rejeté'

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentities

Nom Descriptif Valeur

userAssignedIdentity

Nom Descriptif Valeur

Exemples d’utilisation

Échantillons Terraform

Un exemple de base de déploiement d’un compte de mise à jour d’appareil IoT Hub.

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    = ["*"]
}