Aracılığıyla paylaş

Microsoft.Devices provisioningServices 2022-02-05

  • Makale

Bicep kaynak tanımı

provisioningServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.Devices/provisioningServices kaynağı oluşturmak için aşağıdaki Bicep'i şablonunuza ekleyin.

resource symbolicname 'Microsoft.Devices/provisioningServices@2022-02-05' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        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'
  }
}

Özellik değerleri

provisioningServices

Ad Açıklama Değer
name Kaynak adı dize (gerekli)

Karakter sınırı: 3-64

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Alfasayısal ile sona erer.
location Kaynak konumu. dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler
Sku Sağlama Hizmeti için SKU bilgileri. IotDpsSkuInfo (gerekli)
Etag Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal ETag kuralına göre üst bilgi olarak da sağlanmalıdır. string
properties Sağlama hizmeti için hizmete özgü özellikler IotDpsPropertiesDescription (gerekli)

IotDpsPropertiesDescription

Ad Açıklama Değer
allocationPolicy Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi. 'GeoLatency'
'Karma'
'Statik'
authorizationPolicies Sağlama hizmeti için yetkilendirme anahtarlarının listesi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency İsteğe bağlı.
DPS örneğinin coğrafi çiftler arası olağanüstü durum kurtarmasını kaldırarak Data Residency etkinleştirilip etkinleştirilmediğini gösterir.		 bool
iotHubs Bu sağlama hizmetiyle ilişkili IoT hub'larının listesi. IotHubDefinitionDescription[]
ipFilterRules IP filtresi kuralları. IpFilterRule[]
privateEndpointConnections Bu IotHub'da oluşturulan özel uç nokta bağlantıları PrivateEndpointConnection[]
provisioningState Sağlama hizmetinin ARM sağlama durumu. string
publicNetworkAccess Genel Ağdan gelen isteklere izin verilip verilmeyeceği 'Devre Dışı'
'Etkin'
state Sağlama hizmetinin geçerli durumu. 'Etkinleştirme'
'ActivationFailed'
'Etkin'
'Silindi'
'Silme'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Devam Ediyor'
'Askıya alındı'
'Askıya Alma'
'Geçiş'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Ad Açıklama Değer
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtar değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (gerekli)
secondaryKey İkincil SAS anahtar değeri. string
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtar değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (gerekli)
secondaryKey İkincil SAS anahtar değeri. string

IotHubDefinitionDescription

Ad Açıklama Değer
allocationWeight belirli bir iot h için uygulanacak ağırlık. int
applyAllocationPolicy belirli bir ioT hub'ı için allocationPolicy uygulama bayrağı. bool
Connectionstring IoT hub'ının bağlantı dizesi. dize (gerekli)
location IoT hub'ının ARM bölgesi. dize (gerekli)

IpFilterRule

Ad Açıklama Değer
action Bu kural tarafından yakalanan istekler için istenen eylem. 'Kabul Et'
'Reddet' (gerekli)
Filtername IP filtresi kuralının adı. dize (gerekli)
ipMask Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize. dize (gerekli)
Hedef Bu kural tarafından yakalanan istekler için hedef. 'tümü'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Ad Açıklama Değer
properties Özel uç nokta bağlantısının özellikleri PrivateEndpointConnectionProperties (gerekli)

PrivateEndpointConnectionProperties

Ad Açıklama Değer
privateEndpoint Özel uç nokta bağlantısının özel uç nokta özelliği PrivateEndpoint
privateLinkServiceConnectionState Özel uç nokta bağlantısının geçerli durumu PrivateLinkServiceConnectionState (gerekli)

PrivateEndpoint

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermez. Tüm özellikler Salt Okunur'dır.

PrivateLinkServiceConnectionState

Ad Açıklama Değer
actionsRequired Özel uç nokta bağlantısı için gereken eylemler string
açıklama Özel uç nokta bağlantısının geçerli durumunun açıklaması dize (gerekli)
durum Özel uç nokta bağlantısının durumu 'Onaylandı'
'Bağlantısı Kesildi'
'Beklemede'
'Reddedildi' (gerekli)

IotDpsSkuInfo

Ad Açıklama Değer
capacity Sağacak birim sayısı int
name Sku adı. 'S1'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
IOT Hub ve Ubuntu edge simülatörü oluşturma

Azure’a dağıtın		 Bu şablon bir IOT Hub'ı ve Sanal Makine Ubuntu uç simülatörü oluşturur.
IoT Hub Cihaz Sağlama Hizmeti oluşturma

Azure’a dağıtın		 Bu şablon bir IoT hub'ı ve IoT Hub Cihaz Sağlama Hizmeti oluşturmanıza ve iki hizmeti birbirine bağlamanıza olanak tanır.

ARM şablonu kaynak tanımı

provisioningServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.Devices/provisioningServices kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-02-05",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "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"
  }
}

Özellik değerleri

provisioningServices

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.Devices/provisioningServices'
apiVersion Kaynak API'sinin sürümü '2022-02-05'
name Kaynak adı dize (gerekli)

Karakter sınırı: 3-64

Geçerli karakterler:
Alfasayısal değerler ve kısa çizgiler.

Alfasayısal ile bitir.
location Kaynak konumu. dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü. Bkz . Şablonlardaki etiketler
Sku Sağlama Hizmeti için Sku bilgileri. IotDpsSkuInfo (gerekli)
Etag Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal ETag kuralına göre üst bilgi olarak da sağlanmalıdır. string
properties Sağlama hizmeti için hizmete özgü özellikler IotDpsPropertiesDescription (gerekli)

IotDpsPropertiesDescription

Ad Açıklama Değer
allocationPolicy Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi. 'GeoLatency'
'Karma'
'Statik'
authorizationPolicies Sağlama hizmeti için yetkilendirme anahtarlarının listesi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency İsteğe bağlı.
COĞRAFI çiftler arası olağanüstü durum kurtarmayı kaldırarak DPS örneğinin Data Residency etkinleştirilip etkinleştirilmediğini gösterir.		 bool
iotHubs Bu sağlama hizmetiyle ilişkili IoT hub'larının listesi. IotHubDefinitionDescription[]
ipFilterRules IP filtresi kuralları. IpFilterRule[]
privateEndpointConnections Bu IotHub'da oluşturulan özel uç nokta bağlantıları PrivateEndpointConnection[]
provisioningState Sağlama hizmetinin ARM sağlama durumu. string
publicNetworkAccess Genel Ağdan gelen isteklere izin verilip verilmeyeceği 'Devre Dışı'
'Etkin'
state Sağlama hizmetinin geçerli durumu. 'Etkinleştirme'
'ActivationFailed'
'Etkin'
'Silindi'
'Silme'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Devam Ediyor'
'Askıya alındı'
'Askıya Alma'
'Geçiş'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Ad Açıklama Değer
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtarı değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (gerekli)
secondaryKey İkincil SAS anahtar değeri. string
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtarı değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (gerekli)
secondaryKey İkincil SAS anahtar değeri. string

IotHubDefinitionDescription

Ad Açıklama Değer
allocationWeight belirli bir iot h için uygulanacak ağırlık. int
applyAllocationPolicy belirli bir iot hub'ı için allocationPolicy uygulama veya uygulamama bayrağı. bool
Connectionstring IoT hub'ının bağlantı dizesi. dize (gerekli)
location IoT hub'ının ARM bölgesi. dize (gerekli)

IpFilterRule

Ad Açıklama Değer
action Bu kural tarafından yakalanan istekler için istenen eylem. 'Kabul Et'
'Reddet' (gerekli)
Filtername IP filtresi kuralının adı. dize (gerekli)
ipMask Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize. dize (gerekli)
Hedef Bu kural tarafından yakalanan istekler için hedef. 'all'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Ad Açıklama Değer
properties Özel uç nokta bağlantısının özellikleri PrivateEndpointConnectionProperties (gerekli)

PrivateEndpointConnectionProperties

Ad Açıklama Değer
privateEndpoint Özel uç nokta bağlantısının özel uç nokta özelliği PrivateEndpoint
privateLinkServiceConnectionState Özel uç nokta bağlantısının geçerli durumu PrivateLinkServiceConnectionState (gerekli)

PrivateEndpoint

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermez. Tüm özellikler Salt Okunur'dır.

PrivateLinkServiceConnectionState

Ad Açıklama Değer
actionsRequired Özel uç nokta bağlantısı için gereken eylemler string
açıklama Özel uç nokta bağlantısının geçerli durumunun açıklaması dize (gerekli)
durum Özel uç nokta bağlantısının durumu 'Onaylandı'
'Bağlantısı Kesildi'
'Beklemede'
'Reddedildi' (gerekli)

IotDpsSkuInfo

Ad Açıklama Değer
capacity Sağacak birim sayısı int
name Sku adı. 'S1'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
IOT Hub ve Ubuntu edge simülatörü oluşturma

Azure’a dağıtın		 Bu şablon bir IOT Hub'ı ve Sanal Makine Ubuntu uç simülatörü oluşturur.
IoT Hub Cihaz Sağlama Hizmeti oluşturma

Azure’a dağıtın		 Bu şablon bir IoT hub'ı ve IoT Hub Cihaz Sağlama Hizmeti oluşturmanıza ve iki hizmeti birbirine bağlamanıza olanak tanır.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

provisioningServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.Devices/provisioningServices kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2022-02-05"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          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 = "S1"
    }
    etag = "string"
  })
}

Özellik değerleri

provisioningServices

Ad Açıklama Değer
tür Kaynak türü "Microsoft.Devices/provisioningServices@2022-02-05"
name Kaynak adı dize (gerekli)

Karakter sınırı: 3-64

Geçerli karakterler:
Alfasayısal değerler ve kısa çizgiler.

Alfasayısal ile bitir.
location Kaynak konumu. dize (gerekli)
parent_id Bir kaynak grubuna dağıtmak için bu kaynak grubunun kimliğini kullanın. dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü.
Sku Sağlama Hizmeti için Sku bilgileri. IotDpsSkuInfo (gerekli)
Etag Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal ETag kuralına göre üst bilgi olarak da sağlanmalıdır. string
properties Sağlama hizmeti için hizmete özgü özellikler IotDpsPropertiesDescription (gerekli)

IotDpsPropertiesDescription

Ad Açıklama Değer
allocationPolicy Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi. "GeoLatency"
"Karma"
"Statik"
authorizationPolicies Sağlama hizmeti için yetkilendirme anahtarlarının listesi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency İsteğe bağlı.
COĞRAFI çiftler arası olağanüstü durum kurtarmayı kaldırarak DPS örneğinin Data Residency etkinleştirilip etkinleştirilmediğini gösterir.		 bool
iotHubs Bu sağlama hizmetiyle ilişkili IoT hub'larının listesi. IotHubDefinitionDescription[]
ipFilterRules IP filtresi kuralları. IpFilterRule[]
privateEndpointConnections Bu IotHub'da oluşturulan özel uç nokta bağlantıları PrivateEndpointConnection[]
provisioningState Sağlama hizmetinin ARM sağlama durumu. string
publicNetworkAccess Genel Ağdan gelen isteklere izin verilip verilmeyeceği "Devre dışı"
"Etkin"
state Sağlama hizmetinin geçerli durumu. "Etkinleştirme"
"ActivationFailed"
"Etkin"
"Silindi"
"Siliniyor"
"DeletionFailed"
"FailingOver"
"FailoverFailed"
"Devam Ediyor"
"Askıya alındı"
"Askıya Alma"
"Geçiş"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Ad Açıklama Değer
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtar değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (gerekli)
secondaryKey İkincil SAS anahtar değeri. string
Keyname Anahtarın adı. dize (gerekli)
primaryKey Birincil SAS anahtar değeri. string
Hak -ları Bu anahtarın sahip olduğu haklar. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (gerekli)
secondaryKey İkincil SAS anahtar değeri. string

IotHubDefinitionDescription

Ad Açıklama Değer
allocationWeight belirli bir iot h için uygulanacak ağırlık. int
applyAllocationPolicy belirli bir ioT hub'ı için allocationPolicy uygulama bayrağı. bool
Connectionstring IoT hub'ının bağlantı dizesi. dize (gerekli)
location IoT hub'ının ARM bölgesi. dize (gerekli)

IpFilterRule

Ad Açıklama Değer
action Bu kural tarafından yakalanan istekler için istenen eylem. "Kabul Et"
"Reddet" (gerekli)
Filtername IP filtresi kuralının adı. dize (gerekli)
ipMask Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize. dize (gerekli)
Hedef Bu kural tarafından yakalanan istekler için hedef. "tümü"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Ad Açıklama Değer
properties Özel uç nokta bağlantısının özellikleri PrivateEndpointConnectionProperties (gerekli)

PrivateEndpointConnectionProperties

Ad Açıklama Değer
privateEndpoint Özel uç nokta bağlantısının özel uç nokta özelliği PrivateEndpoint
privateLinkServiceConnectionState Özel uç nokta bağlantısının geçerli durumu PrivateLinkServiceConnectionState (gerekli)

PrivateEndpoint

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermez. Tüm özellikler Salt Okunur'dır.

PrivateLinkServiceConnectionState

Ad Açıklama Değer
actionsRequired Özel uç nokta bağlantısı için gereken eylemler string
açıklama Özel uç nokta bağlantısının geçerli durumunun açıklaması dize (gerekli)
durum Özel uç nokta bağlantısının durumu "Onaylandı"
"Bağlantısı Kesildi"
"Beklemede"
"Reddedildi" (gerekli)

IotDpsSkuInfo

Ad Açıklama Değer
capacity Sağacak birim sayısı int
name Sku adı. "S1"