Udostępnij przez


Konta Microsoft.DeviceUpdate

Definicja zasobu Bicep

Typ zasobu kont można wdrożyć przy użyciu operacji, które są przeznaczone:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DeviceUpdate/accounts, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.DeviceUpdate/konta

Nazwa Opis Wartość
tożsamość Typ tożsamości używany dla zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 24
Wzorzec = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (wymagane)
Właściwości Właściwości konta usługi Device Update. Właściwości konta
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Właściwości konta

Nazwa Opis Wartość
szyfrowanie Szyfrowanie cmK we właściwościach magazynowanych Szyfrowanie
privateEndpointConnections (połączenia prywatnegopunktu końcowego) Lista połączeń prywatnego punktu końcowego skojarzonych z kontem. PrivateEndpointConnection[]
dostęp do sieci publicznej Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla konta. "Wyłączone"
"Włączone"
Numer jednostki magazynowej Jednostka SKU aktualizacji urządzenia "Bezpłatna"
"Standardowa"

Szyfrowanie

Nazwa Opis Wartość
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
tożsamość przypisana przez użytkownika Pełny identyfikator resourceId tożsamości przypisanej przez użytkownika do użycia na potrzeby dostępu do magazynu kluczy. Tożsamość musi być również przypisana do konta ciąg

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

Prywatny punkt końcowy

Nazwa Opis Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa Opis Wartość
Właściwości Właściwości zasobu. PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds (identyfikatory grup) Tablica identyfikatorów grup. ciąg znakowy[]
privateEndpoint (punkt końcowy prywatny) Zasób prywatnego punktu końcowego. PrivateEndpoint
privateLinkServiceConnectionState Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired (wymagane działania) Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. ciąg
opis Przyczyna zatwierdzenia/odrzucenia połączenia. ciąg
stan Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. "Zatwierdzone"
"Oczekujące"
"Odrzucono"

Śledzone tagi zasobów

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
tworzenie aktualizacji urządzenia dla konta usługi IoT Hub Ten szablon tworzy konto, które udostępnia publiczny rekord DNS i umożliwia wykonywanie wywołań interfejsu API REST do płaszczyzny danych. Następnie użytkownik musi utworzyć wystąpienie w ramach konta i połączyć je z usługą IoT Hub, aby rozpocząć korzystanie z usługi.
Tworzenie aktualizacji urządzenia dla konta usługi IoT Hub, wystąpienia, usługi IoT Hub Ten szablon tworzy konto, wystąpienie i centrum w celu połączenia wystąpienia z nim. Konfiguruje koncentrator z niezbędnymi zasadami dostępu, trasami i grupą konsumentów.

Definicja zasobu szablonu usługi ARM

Typ zasobu kont można wdrożyć przy użyciu operacji, które są przeznaczone:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DeviceUpdate/accounts, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.DeviceUpdate/konta

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2023-07-01'
tożsamość Typ tożsamości używany dla zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 24
Wzorzec = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (wymagane)
Właściwości Właściwości konta usługi Device Update. Właściwości konta
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DeviceUpdate/accounts"

Właściwości konta

Nazwa Opis Wartość
szyfrowanie Szyfrowanie cmK we właściwościach magazynowanych Szyfrowanie
privateEndpointConnections (połączenia prywatnegopunktu końcowego) Lista połączeń prywatnego punktu końcowego skojarzonych z kontem. PrivateEndpointConnection[]
dostęp do sieci publicznej Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla konta. "Wyłączone"
"Włączone"
Numer jednostki magazynowej Jednostka SKU aktualizacji urządzenia "Bezpłatna"
"Standardowa"

Szyfrowanie

Nazwa Opis Wartość
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
tożsamość przypisana przez użytkownika Pełny identyfikator resourceId tożsamości przypisanej przez użytkownika do użycia na potrzeby dostępu do magazynu kluczy. Tożsamość musi być również przypisana do konta ciąg

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

Prywatny punkt końcowy

Nazwa Opis Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa Opis Wartość
Właściwości Właściwości zasobu. PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds (identyfikatory grup) Tablica identyfikatorów grup. ciąg znakowy[]
privateEndpoint (punkt końcowy prywatny) Zasób prywatnego punktu końcowego. PrivateEndpoint
privateLinkServiceConnectionState Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired (wymagane działania) Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. ciąg
opis Przyczyna zatwierdzenia/odrzucenia połączenia. ciąg
stan Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. "Zatwierdzone"
"Oczekujące"
"Odrzucono"

Śledzone tagi zasobów

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
tworzenie aktualizacji urządzenia dla konta usługi IoT Hub

wdrażanie w usłudze Azure
Ten szablon tworzy konto, które udostępnia publiczny rekord DNS i umożliwia wykonywanie wywołań interfejsu API REST do płaszczyzny danych. Następnie użytkownik musi utworzyć wystąpienie w ramach konta i połączyć je z usługą IoT Hub, aby rozpocząć korzystanie z usługi.
Tworzenie aktualizacji urządzenia dla konta usługi IoT Hub, wystąpienia, usługi IoT Hub

wdrażanie w usłudze Azure
Ten szablon tworzy konto, wystąpienie i centrum w celu połączenia wystąpienia z nim. Konfiguruje koncentrator z niezbędnymi zasadami dostępu, trasami i grupą konsumentów.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu kont można wdrożyć przy użyciu operacji, które są przeznaczone:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DeviceUpdate/accounts, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.DeviceUpdate/konta

Nazwa Opis Wartość
tożsamość Typ tożsamości używany dla zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 24
Wzorzec = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (wymagane)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Właściwości konta usługi Device Update. Właściwości konta
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DeviceUpdate/accounts@2023-07-01"

Właściwości konta

Nazwa Opis Wartość
szyfrowanie Szyfrowanie cmK we właściwościach magazynowanych Szyfrowanie
privateEndpointConnections (połączenia prywatnegopunktu końcowego) Lista połączeń prywatnego punktu końcowego skojarzonych z kontem. PrivateEndpointConnection[]
dostęp do sieci publicznej Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla konta. "Wyłączone"
"Włączone"
Numer jednostki magazynowej Jednostka SKU aktualizacji urządzenia "Bezpłatna"
"Standardowa"

Szyfrowanie

Nazwa Opis Wartość
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
tożsamość przypisana przez użytkownika Pełny identyfikator resourceId tożsamości przypisanej przez użytkownika do użycia na potrzeby dostępu do magazynu kluczy. Tożsamość musi być również przypisana do konta ciąg

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

Prywatny punkt końcowy

Nazwa Opis Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa Opis Wartość
Właściwości Właściwości zasobu. PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds (identyfikatory grup) Tablica identyfikatorów grup. ciąg znakowy[]
privateEndpoint (punkt końcowy prywatny) Zasób prywatnego punktu końcowego. PrivateEndpoint
privateLinkServiceConnectionState Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired (wymagane działania) Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. ciąg
opis Przyczyna zatwierdzenia/odrzucenia połączenia. ciąg
stan Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. "Zatwierdzone"
"Oczekujące"
"Odrzucono"

Śledzone tagi zasobów

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania konta aktualizacji urządzenia 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    = ["*"]
}