Freigeben über


Microsoft.DeviceUpdate-Konten

Bicep-Ressourcendefinition

Der Ressourcentyp "Konten" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DeviceUpdate/accounts-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.

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

Eigenschaftswerte

Microsoft.DeviceUpdate/accounts

Name Beschreibung Wert
Identität Der Identitätstyp, der für die Ressource verwendet wird. ManagedServiceIdentity-
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 24
Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (erforderlich)
Eigenschaften Geräteaktualisierungskontoeigenschaften. AccountProperties-
scope Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

Account-Eigenschaften

Name Beschreibung Wert
Verschlüsselung CMK-Verschlüsselung bei ruhenden Eigenschaften Verschlüsselungs-
privateEndpointConnections. Liste der privaten Endpunktverbindungen, die dem Konto zugeordnet sind. PrivateEndpointConnection[]
Öffentlicher Netzwerkzugang Gibt an, ob der Zugriff auf das öffentliche Netzwerk für das Konto zulässig ist. "Deaktiviert"
"Aktiviert"
Sku Geräteupdate-Sku "Kostenlos"
"Standard"

Verschlüsselung

Name Beschreibung Wert
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
userAssignedIdentity Die vollständige resourceId der vom Benutzer zugewiesenen Identität, die für den Schlüsseltresorzugriff verwendet werden soll. Die Identität muss auch dem Konto zugewiesen werden. Schnur

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. UserAssignedIdentities-

PrivateEndpoint

Name Beschreibung Wert

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Ressourceneigenschaften. PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name Beschreibung Wert
Gruppen-IDs Array von Gruppen-IDs. Zeichenfolge[]
privateEndpoint Die Ressource des privaten Endpunkts. PrivateEndpoint-
privateLinkServiceConnectionState Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider. PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name Beschreibung Wert
Erforderliche Aktionen Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern. Schnur
Beschreibung Der Grund für die Genehmigung/Ablehnung der Verbindung. Schnur
Status Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde. "Genehmigt"
"Ausstehend"
"Abgelehnt"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentities

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert

Verwendungsbeispiele

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
Erstellen eines Geräteupdates für IoT Hub-Konto Diese Vorlage erstellt ein Konto, das einen öffentlichen DNS-Eintrag bereitstellt und es ermöglicht, REST-API-Aufrufe an Data Plane zu tätigen. Anschließend muss der Benutzer eine Instanz unter dem Konto erstellen und mit einem IoT Hub verknüpfen, um mit der Verwendung des Diensts zu beginnen.
Erstellen des Geräteupdates für IoT Hub-Konto, Instanz, IoT Hub- Diese Vorlage erstellt ein Konto und eine Instanz und einen Hub, mit dem die Instanz verknüpft werden soll. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Verbrauchergruppen.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Konten" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DeviceUpdate/accounts-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Microsoft.DeviceUpdate/accounts

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2023-07-01'
Identität Der Identitätstyp, der für die Ressource verwendet wird. ManagedServiceIdentity-
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 24
Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (erforderlich)
Eigenschaften Geräteaktualisierungskontoeigenschaften. AccountProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.DeviceUpdate/accounts"

Account-Eigenschaften

Name Beschreibung Wert
Verschlüsselung CMK-Verschlüsselung bei ruhenden Eigenschaften Verschlüsselungs-
privateEndpointConnections. Liste der privaten Endpunktverbindungen, die dem Konto zugeordnet sind. PrivateEndpointConnection[]
Öffentlicher Netzwerkzugang Gibt an, ob der Zugriff auf das öffentliche Netzwerk für das Konto zulässig ist. "Deaktiviert"
"Aktiviert"
Sku Geräteupdate-Sku "Kostenlos"
"Standard"

Verschlüsselung

Name Beschreibung Wert
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
userAssignedIdentity Die vollständige resourceId der vom Benutzer zugewiesenen Identität, die für den Schlüsseltresorzugriff verwendet werden soll. Die Identität muss auch dem Konto zugewiesen werden. Schnur

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. UserAssignedIdentities-

PrivateEndpoint

Name Beschreibung Wert

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Ressourceneigenschaften. PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name Beschreibung Wert
Gruppen-IDs Array von Gruppen-IDs. Zeichenfolge[]
privateEndpoint Die Ressource des privaten Endpunkts. PrivateEndpoint-
privateLinkServiceConnectionState Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider. PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name Beschreibung Wert
Erforderliche Aktionen Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern. Schnur
Beschreibung Der Grund für die Genehmigung/Ablehnung der Verbindung. Schnur
Status Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde. "Genehmigt"
"Ausstehend"
"Abgelehnt"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentities

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Erstellen eines Geräteupdates für IoT Hub-Konto

Bereitstellen in Azure
Diese Vorlage erstellt ein Konto, das einen öffentlichen DNS-Eintrag bereitstellt und es ermöglicht, REST-API-Aufrufe an Data Plane zu tätigen. Anschließend muss der Benutzer eine Instanz unter dem Konto erstellen und mit einem IoT Hub verknüpfen, um mit der Verwendung des Diensts zu beginnen.
Erstellen des Geräteupdates für IoT Hub-Konto, Instanz, IoT Hub-

Bereitstellen in Azure
Diese Vorlage erstellt ein Konto und eine Instanz und einen Hub, mit dem die Instanz verknüpft werden soll. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Verbrauchergruppen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Konten" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Ressource "Microsoft.DeviceUpdate/accounts" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.DeviceUpdate/accounts

Name Beschreibung Wert
Identität Der Identitätstyp, der für die Ressource verwendet wird. ManagedServiceIdentity-
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 24
Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Geräteaktualisierungskontoeigenschaften. AccountProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.DeviceUpdate/accounts@2023-07-01"

Account-Eigenschaften

Name Beschreibung Wert
Verschlüsselung CMK-Verschlüsselung bei ruhenden Eigenschaften Verschlüsselungs-
privateEndpointConnections. Liste der privaten Endpunktverbindungen, die dem Konto zugeordnet sind. PrivateEndpointConnection[]
Öffentlicher Netzwerkzugang Gibt an, ob der Zugriff auf das öffentliche Netzwerk für das Konto zulässig ist. "Deaktiviert"
"Aktiviert"
Sku Geräteupdate-Sku "Kostenlos"
"Standard"

Verschlüsselung

Name Beschreibung Wert
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
userAssignedIdentity Die vollständige resourceId der vom Benutzer zugewiesenen Identität, die für den Schlüsseltresorzugriff verwendet werden soll. Die Identität muss auch dem Konto zugewiesen werden. Schnur

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. UserAssignedIdentities-

PrivateEndpoint

Name Beschreibung Wert

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Ressourceneigenschaften. PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name Beschreibung Wert
Gruppen-IDs Array von Gruppen-IDs. Zeichenfolge[]
privateEndpoint Die Ressource des privaten Endpunkts. PrivateEndpoint-
privateLinkServiceConnectionState Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider. PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name Beschreibung Wert
Erforderliche Aktionen Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern. Schnur
Beschreibung Der Grund für die Genehmigung/Ablehnung der Verbindung. Schnur
Status Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde. "Genehmigt"
"Ausstehend"
"Abgelehnt"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentities

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung eines IoT Hub-Geräteaktualisierungskontos.

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