Microsoft.Devices provisioningServices 2021-10-15

• najnowsze
• 2025-02-01-preview
• 2023-03-01-preview
• 2022-12-12
• 2022-02-05
• 2021-10-15
• 2020-09-01-preview
• 2020-03-01
• 2020-01-01
• 2018-01-22
• 2017-11-15
• 2017-08-21-preview

Definicja zasobu Bicep

Typ zasobu provisioningServices można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-15' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    enableDataResidency: bool
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

IotDpsPropertiesDescription

Nazwa	Opis	Wartość
allocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.	"GeoLatency" "Skrót" "Statyczny"
authorizationPolicies	Lista kluczy autoryzacji dla usługi aprowizacji.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Fakultatywny. Wskazuje, czy wystąpienie usługi DPS ma włączoną rezydencję danych, usuwając odzyskiwanie po awarii między parami geograficznymi.	Bool
iotHubs	Lista centrów IoT skojarzonych z tą usługą aprowizacji.	IotHubDefinitionDescription[]
ipFilterRules	Reguły filtrowania adresów IP.	IpFilterRule []
privateEndpointConnections	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub	PrivateEndpointConnection[]
provisioningState	Stan aprowizacji usługi ARM dla usługi aprowizacji.	struna
publicNetworkAccess	Czy żądania z sieci publicznej są dozwolone	"Wyłączone" "Włączone"
stan	Bieżący stan usługi aprowizacji.	"Aktywowanie" "ActivationFailed" "Aktywne" "Usunięte" "Usuwanie" "DeletionFailed" "Tryb failOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przejście"

IotDpsSkuInfo

Nazwa	Opis	Wartość
pojemność	Liczba jednostek do aprowizacji	Int
nazwa	Nazwa jednostki SKU.	"S1"

IotHubDefinitionDescription

Nazwa	Opis	Wartość
alokacja waga	waga do ubiegania się o daną iot h.	Int
applyAllocationPolicy	flaga stosowania elementu allocationPolicy lub nie dla danego centrum iot.	Bool
connectionString	Parametry połączenia centrum IoT Hub.	ciąg (wymagany)
lokalizacja	Region usługi ARM centrum IoT.	ciąg (wymagany)

IpFilterRule

Nazwa	Opis	Wartość
akcja	Żądana akcja żądań przechwyconych przez tę regułę.	"Zaakceptuj" "Odrzuć" (wymagane)
filterName	Nazwa reguły filtru adresów IP.	ciąg (wymagany)
maska ip	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.	ciąg (wymagany)
cel	Element docelowy dla żądań przechwyconych przez tę regułę.	"wszystko" "deviceApi" "serviceApi"

Microsoft.Devices/provisioningServices

Nazwa	Opis	Wartość
etag	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.	struna
lokalizacja	Lokalizacja zasobu.	ciąg (wymagany)
nazwa	Nazwa zasobu	ciąg (wymagany)
Właściwości	Właściwości specyficzne dla usługi aprowizacji	IotDpsPropertiesDescription (wymagane)
Numer jednostki magazynowej	Informacje o jednostce SKU dla usługi aprowizacji.	IotDpsSkuInfo (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach

PrivateEndpoint

Nazwa	Opis	Wartość

PrivateEndpointConnection

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego	PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego	PrivateEndpoint
privateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego	PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Akcje wymagane dla połączenia prywatnego punktu końcowego	struna
opis	Opis bieżącego stanu połączenia prywatnego punktu końcowego	ciąg (wymagany)
stan	Stan połączenia prywatnego punktu końcowego	"Zatwierdzone" "Rozłączono" "Oczekujące" "Odrzucono" (wymagane)

Tagi zasobów

Nazwa	Opis	Wartość

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nazwa	Opis	Wartość
keyName	Nazwa klucza.	ciąg (wymagany)
primaryKey	Podstawowa wartość klucza sygnatury dostępu współdzielonego.	struna
prawa	Prawa, które ma ten klucz.	"DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane)
secondaryKey	Pomocnicza wartość klucza sygnatury dostępu współdzielonego.	struna

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep	Opis
tworzenie usługi IoT Hub Device Provisioning Service	Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług.

Definicja zasobu szablonu usługi ARM

Typ zasobu provisioningServices można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2021-10-15",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "enableDataResidency": "bool",
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

IotDpsPropertiesDescription

Nazwa	Opis	Wartość
allocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.	"GeoLatency" "Skrót" "Statyczny"
authorizationPolicies	Lista kluczy autoryzacji dla usługi aprowizacji.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Fakultatywny. Wskazuje, czy wystąpienie usługi DPS ma włączoną rezydencję danych, usuwając odzyskiwanie po awarii między parami geograficznymi.	Bool
iotHubs	Lista centrów IoT skojarzonych z tą usługą aprowizacji.	IotHubDefinitionDescription[]
ipFilterRules	Reguły filtrowania adresów IP.	IpFilterRule []
privateEndpointConnections	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub	PrivateEndpointConnection[]
provisioningState	Stan aprowizacji usługi ARM dla usługi aprowizacji.	struna
publicNetworkAccess	Czy żądania z sieci publicznej są dozwolone	"Wyłączone" "Włączone"
stan	Bieżący stan usługi aprowizacji.	"Aktywowanie" "ActivationFailed" "Aktywne" "Usunięte" "Usuwanie" "DeletionFailed" "Tryb failOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przejście"

IotDpsSkuInfo

Nazwa	Opis	Wartość
pojemność	Liczba jednostek do aprowizacji	Int
nazwa	Nazwa jednostki SKU.	"S1"

IotHubDefinitionDescription

Nazwa	Opis	Wartość
alokacja waga	waga do ubiegania się o daną iot h.	Int
applyAllocationPolicy	flaga stosowania elementu allocationPolicy lub nie dla danego centrum iot.	Bool
connectionString	Parametry połączenia centrum IoT Hub.	ciąg (wymagany)
lokalizacja	Region usługi ARM centrum IoT.	ciąg (wymagany)

IpFilterRule

Nazwa	Opis	Wartość
akcja	Żądana akcja żądań przechwyconych przez tę regułę.	"Zaakceptuj" "Odrzuć" (wymagane)
filterName	Nazwa reguły filtru adresów IP.	ciąg (wymagany)
maska ip	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.	ciąg (wymagany)
cel	Element docelowy dla żądań przechwyconych przez tę regułę.	"wszystko" "deviceApi" "serviceApi"

Microsoft.Devices/provisioningServices

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2021-10-15'
etag	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.	struna
lokalizacja	Lokalizacja zasobu.	ciąg (wymagany)
nazwa	Nazwa zasobu	ciąg (wymagany)
Właściwości	Właściwości specyficzne dla usługi aprowizacji	IotDpsPropertiesDescription (wymagane)
Numer jednostki magazynowej	Informacje o jednostce SKU dla usługi aprowizacji.	IotDpsSkuInfo (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ	Typ zasobu	"Microsoft.Devices/provisioningServices"

PrivateEndpoint

Nazwa	Opis	Wartość

PrivateEndpointConnection

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego	PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego	PrivateEndpoint
privateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego	PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Akcje wymagane dla połączenia prywatnego punktu końcowego	struna
opis	Opis bieżącego stanu połączenia prywatnego punktu końcowego	ciąg (wymagany)
stan	Stan połączenia prywatnego punktu końcowego	"Zatwierdzone" "Rozłączono" "Oczekujące" "Odrzucono" (wymagane)

Tagi zasobów

Nazwa	Opis	Wartość

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nazwa	Opis	Wartość
keyName	Nazwa klucza.	ciąg (wymagany)
primaryKey	Podstawowa wartość klucza sygnatury dostępu współdzielonego.	struna
prawa	Prawa, które ma ten klucz.	"DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane)
secondaryKey	Pomocnicza wartość klucza sygnatury dostępu współdzielonego.	struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
Tworzenie symulatora usługi IOT Hub i ubuntu edge wdrażanie	Ten szablon umożliwia utworzenie symulatora brzegowego centrum IOT i maszyny wirtualnej z systemem Ubuntu.
tworzenie usługi IoT Hub Device Provisioning Service wdrażanie	Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu provisioningServices można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2021-10-15"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      enableDataResidency = bool
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
  })
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Wartości właściwości

IotDpsPropertiesDescription

Nazwa	Opis	Wartość
allocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.	"GeoLatency" "Skrót" "Statyczny"
authorizationPolicies	Lista kluczy autoryzacji dla usługi aprowizacji.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Fakultatywny. Wskazuje, czy wystąpienie usługi DPS ma włączoną rezydencję danych, usuwając odzyskiwanie po awarii między parami geograficznymi.	Bool
iotHubs	Lista centrów IoT skojarzonych z tą usługą aprowizacji.	IotHubDefinitionDescription[]
ipFilterRules	Reguły filtrowania adresów IP.	IpFilterRule []
privateEndpointConnections	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub	PrivateEndpointConnection[]
provisioningState	Stan aprowizacji usługi ARM dla usługi aprowizacji.	struna
publicNetworkAccess	Czy żądania z sieci publicznej są dozwolone	"Wyłączone" "Włączone"
stan	Bieżący stan usługi aprowizacji.	"Aktywowanie" "ActivationFailed" "Aktywne" "Usunięte" "Usuwanie" "DeletionFailed" "Tryb failOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przejście"

IotDpsSkuInfo

Nazwa	Opis	Wartość
pojemność	Liczba jednostek do aprowizacji	Int
nazwa	Nazwa jednostki SKU.	"S1"

IotHubDefinitionDescription

Nazwa	Opis	Wartość
alokacja waga	waga do ubiegania się o daną iot h.	Int
applyAllocationPolicy	flaga stosowania elementu allocationPolicy lub nie dla danego centrum iot.	Bool
connectionString	Parametry połączenia centrum IoT Hub.	ciąg (wymagany)
lokalizacja	Region usługi ARM centrum IoT.	ciąg (wymagany)

IpFilterRule

Nazwa	Opis	Wartość
akcja	Żądana akcja żądań przechwyconych przez tę regułę.	"Zaakceptuj" "Odrzuć" (wymagane)
filterName	Nazwa reguły filtru adresów IP.	ciąg (wymagany)
maska ip	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.	ciąg (wymagany)
cel	Element docelowy dla żądań przechwyconych przez tę regułę.	"wszystko" "deviceApi" "serviceApi"

Microsoft.Devices/provisioningServices

Nazwa	Opis	Wartość
etag	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.	struna
lokalizacja	Lokalizacja zasobu.	ciąg (wymagany)
nazwa	Nazwa zasobu	ciąg (wymagany)
Właściwości	Właściwości specyficzne dla usługi aprowizacji	IotDpsPropertiesDescription (wymagane)
Numer jednostki magazynowej	Informacje o jednostce SKU dla usługi aprowizacji.	IotDpsSkuInfo (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.Devices/provisioningServices@2021-10-15"

PrivateEndpoint

Nazwa	Opis	Wartość

PrivateEndpointConnection

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego	PrivateEndpointConnectionProperties (wymagane)

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego	PrivateEndpoint
privateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego	PrivateLinkServiceConnectionState (wymagane)

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Akcje wymagane dla połączenia prywatnego punktu końcowego	struna
opis	Opis bieżącego stanu połączenia prywatnego punktu końcowego	ciąg (wymagany)
stan	Stan połączenia prywatnego punktu końcowego	"Zatwierdzone" "Rozłączono" "Oczekujące" "Odrzucono" (wymagane)

Tagi zasobów

Nazwa	Opis	Wartość

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nazwa	Opis	Wartość
keyName	Nazwa klucza.	ciąg (wymagany)
primaryKey	Podstawowa wartość klucza sygnatury dostępu współdzielonego.	struna
prawa	Prawa, które ma ten klucz.	"DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane)
secondaryKey	Pomocnicza wartość klucza sygnatury dostępu współdzielonego.	struna