Penyediaan Microsoft.DevicesServices 2022-02-05

  • Artikel

Definisi sumber daya Bicep

Jenis sumber daya provisioningServices dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.Devices/provisioningServices, tambahkan Bicep berikut ke templat Anda.

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

Nilai properti

provisioningServices

Nama Deskripsi Nilai
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-64

Karakter yang valid:
Alfanumerik dan tanda hubung.

Akhiri dengan alfanumerik.
lokasi Lokasi sumber daya. string (diperlukan)
tag Tag sumber daya. Kamus nama dan nilai tag. Lihat Tag dalam templat
sku Info Sku untuk Layanan provisi. IotDpsSkuInfo (diperlukan)
etag Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. string
properti Properti khusus layanan untuk layanan provisi IotDpsPropertiesDescription (diperlukan)

IotDpsPropertiesDescription

Nama Deskripsi Nilai
allocationPolicy Kebijakan alokasi yang akan digunakan oleh layanan provisi ini. 'GeoLatency'
'Hashed'
'Statis'
authorizationPolicies Daftar kunci otorisasi untuk layanan provisi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Pilihan.
Menunjukkan apakah instans DPS telah Data Residency diaktifkan, menghapus pemulihan bencana lintas pasangan geografis.		 bool
iotHubs Daftar hub IoT yang terkait dengan layanan provisi ini. IotHubDefinitionDescription[]
ipFilterRules Aturan filter IP. IpFilterRule[]
privateEndpointConnections Koneksi titik akhir privat yang dibuat pada IotHub ini PrivateEndpointConnection[]
provisioningState Status penyediaan ARM dari layanan provisi. string
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Dinonaktifkan'
'Diaktifkan'
state Status layanan provisi saat ini. 'Mengaktifkan'
'ActivationFailed'
'Aktif'
'Dihapus'
'Menghapus'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Melanjutkan'
'Ditangguhkan'
'Menangguhkan'
'Transisi'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nama Deskripsi Nilai
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string

IotHubDefinitionDescription

Nama Deskripsi Nilai
allocationWeight berat untuk melamar iot h tertentu. int
applyAllocationPolicy bendera untuk menerapkan allocationPolicy atau tidak untuk hub iot tertentu. bool
connectionString String koneksi hub IoT. string (diperlukan)
lokasi Wilayah ARM IoT hub. string (diperlukan)

IpFilterRule

Nama Deskripsi Nilai
tindakan Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. 'Terima'
'Tolak' (diperlukan)
filterName Nama aturan filter IP. string (diperlukan)
ipMask String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. string (diperlukan)
target Target untuk permintaan yang diambil oleh aturan ini. 'semua'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Nama Deskripsi Nilai
properti Properti koneksi titik akhir privat PrivateEndpointConnectionProperties (diperlukan)

PrivateEndpointConnectionProperties

Nama Deskripsi Nilai
privateEndpoint Properti titik akhir privat dari koneksi titik akhir privat PrivateEndpoint
privateLinkServiceConnectionState Status koneksi titik akhir privat saat ini PrivateLinkServiceConnectionState (diperlukan)

PrivateEndpoint

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama Deskripsi Nilai
actionsRequired Tindakan yang diperlukan untuk koneksi titik akhir privat string
deskripsi Deskripsi untuk status koneksi titik akhir privat saat ini string (diperlukan)
status Status koneksi titik akhir privat 'Disetujui'
'Terputus'
'Tertunda'
'Ditolak' (diperlukan)

IotDpsSkuInfo

Nama Deskripsi Nilai
kapasitas Jumlah unit yang akan disediakan int
nama Nama Sku. 'S1'

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat IOT Hub dan simulator tepi Ubuntu

Sebarkan ke Azure		 Templat ini membuat simulator tepi IOT Hub dan Virtual Machine Ubuntu.
Membuat IoT Hub Device Provisioning Service

Sebarkan ke Azure		 Templat ini memungkinkan Anda membuat hub IoT dan IoT Hub Device Provisioning Service, dan menautkan kedua layanan bersama-sama.

Definisi sumber daya templat ARM

Jenis sumber daya provisioningServices dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.Devices/provisioningServices, tambahkan JSON berikut ke templat Anda.

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

Nilai properti

provisioningServices

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.Devices/provisioningServices'
apiVersion Versi api sumber daya '2022-02-05'
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-64

Karakter yang valid:
Alfanumerik dan tanda hubung.

Akhiri dengan alfanumerik.
lokasi Lokasi sumber daya. string (diperlukan)
tag Tag sumber daya. Kamus nama dan nilai tag. Lihat Tag dalam templat
sku Info Sku untuk Layanan provisi. IotDpsSkuInfo (diperlukan)
etag Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. string
properti Properti khusus layanan untuk layanan provisi IotDpsPropertiesDescription (diperlukan)

IotDpsPropertiesDescription

Nama Deskripsi Nilai
allocationPolicy Kebijakan alokasi yang akan digunakan oleh layanan provisi ini. 'GeoLatency'
'Hashed'
'Statis'
authorizationPolicies Daftar kunci otorisasi untuk layanan provisi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Pilihan.
Menunjukkan apakah instans DPS telah Data Residency diaktifkan, menghapus pemulihan bencana lintas pasangan geografis.		 bool
iotHubs Daftar hub IoT yang terkait dengan layanan provisi ini. IotHubDefinitionDescription[]
ipFilterRules Aturan filter IP. IpFilterRule[]
privateEndpointConnections Koneksi titik akhir privat yang dibuat pada IotHub ini PrivateEndpointConnection[]
provisioningState Status penyediaan ARM dari layanan provisi. string
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Dinonaktifkan'
'Diaktifkan'
state Status layanan provisi saat ini. 'Mengaktifkan'
'ActivationFailed'
'Aktif'
'Dihapus'
'Menghapus'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Melanjutkan'
'Ditangguhkan'
'Menangguhkan'
'Transisi'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nama Deskripsi Nilai
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string

IotHubDefinitionDescription

Nama Deskripsi Nilai
allocationWeight berat untuk diterapkan untuk iot h tertentu. int
applyAllocationPolicy bendera untuk menerapkan allocationPolicy atau tidak untuk hub iot tertentu. bool
connectionString String koneksi hub IoT. string (diperlukan)
lokasi Wilayah ARM hub IoT. string (diperlukan)

IpFilterRule

Nama Deskripsi Nilai
tindakan Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. 'Terima'
'Tolak' (diperlukan)
filterName Nama aturan filter IP. string (diperlukan)
ipMask String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. string (diperlukan)
target Target untuk permintaan yang diambil oleh aturan ini. 'semua'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Nama Deskripsi Nilai
properti Properti koneksi titik akhir privat PrivateEndpointConnectionProperties (diperlukan)

PrivateEndpointConnectionProperties

Nama Deskripsi Nilai
privateEndpoint Properti titik akhir privat dari koneksi titik akhir privat PrivateEndpoint
privateLinkServiceConnectionState Status koneksi titik akhir privat saat ini PrivateLinkServiceConnectionState (diperlukan)

PrivateEndpoint

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama Deskripsi Nilai
actionsRequired Tindakan yang diperlukan untuk koneksi titik akhir privat string
deskripsi Deskripsi untuk status koneksi titik akhir privat saat ini string (diperlukan)
status Status koneksi titik akhir privat 'Disetujui'
'Terputus'
'Tertunda'
'Ditolak' (diperlukan)

IotDpsSkuInfo

Nama Deskripsi Nilai
kapasitas Jumlah unit yang akan disediakan int
nama Nama Sku. 'S1'

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat IOT Hub dan simulator tepi Ubuntu

Sebarkan ke Azure		 Templat ini membuat simulator tepi IOT Hub dan Virtual Machine Ubuntu.
Membuat IoT Hub Device Provisioning Service

Sebarkan ke Azure		 Templat ini memungkinkan Anda membuat hub IoT dan IoT Hub Device Provisioning Service, dan menautkan kedua layanan bersama-sama.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya provisioningServices dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.Devices/provisioningServices, tambahkan Terraform berikut ke templat Anda.

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

Nilai properti

provisioningServices

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.Devices/provisioningServices@2022-02-05"
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-64

Karakter yang valid:
Alfanumerik dan tanda hubung.

Akhiri dengan alfanumerik.
lokasi Lokasi sumber daya. string (diperlukan)
parent_id Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. string (diperlukan)
tag Tag sumber daya. Kamus nama dan nilai tag.
sku Info Sku untuk Layanan provisi. IotDpsSkuInfo (diperlukan)
etag Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. string
properti Properti khusus layanan untuk layanan provisi IotDpsPropertiesDescription (diperlukan)

IotDpsPropertiesDescription

Nama Deskripsi Nilai
allocationPolicy Kebijakan alokasi yang akan digunakan oleh layanan provisi ini. "GeoLatency"
"Hashed"
"Statis"
authorizationPolicies Daftar kunci otorisasi untuk layanan provisi. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Pilihan.
Menunjukkan apakah instans DPS telah Data Residency diaktifkan, menghapus pemulihan bencana lintas pasangan geografis.		 bool
iotHubs Daftar hub IoT yang terkait dengan layanan provisi ini. IotHubDefinitionDescription[]
ipFilterRules Aturan filter IP. IpFilterRule[]
privateEndpointConnections Koneksi titik akhir privat yang dibuat pada IotHub ini PrivateEndpointConnection[]
provisioningState Status penyediaan ARM dari layanan provisi. string
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan "Dinonaktifkan"
"Diaktifkan"
state Status layanan provisi saat ini. "Mengaktifkan"
"ActivationFailed"
"Aktif"
"Dihapus"
"Menghapus"
"DeletionFailed"
"FailingOver"
"FailoverFailed"
"Melanjutkan"
"Ditangguhkan"
"Menangguhkan"
"Transisi"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nama Deskripsi Nilai
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string
keyName Nama kunci. string (diperlukan)
primaryKey Nilai kunci SAS utama. string
Hak Hak yang dimiliki kunci ini. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (diperlukan)
secondaryKey Nilai kunci SAS sekunder. string

IotHubDefinitionDescription

Nama Deskripsi Nilai
allocationWeight berat untuk melamar iot h tertentu. int
applyAllocationPolicy bendera untuk menerapkan allocationPolicy atau tidak untuk hub iot tertentu. bool
connectionString String koneksi hub IoT. string (diperlukan)
lokasi Wilayah ARM IoT hub. string (diperlukan)

IpFilterRule

Nama Deskripsi Nilai
tindakan Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. "Terima"
"Tolak" (diperlukan)
filterName Nama aturan filter IP. string (diperlukan)
ipMask String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. string (diperlukan)
target Target untuk permintaan yang diambil oleh aturan ini. "semua"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Nama Deskripsi Nilai
properti Properti koneksi titik akhir privat PrivateEndpointConnectionProperties (diperlukan)

PrivateEndpointConnectionProperties

Nama Deskripsi Nilai
privateEndpoint Properti titik akhir privat dari koneksi titik akhir privat PrivateEndpoint
privateLinkServiceConnectionState Status koneksi titik akhir privat saat ini PrivateLinkServiceConnectionState (diperlukan)

PrivateEndpoint

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama Deskripsi Nilai
actionsRequired Tindakan yang diperlukan untuk koneksi titik akhir privat string
deskripsi Deskripsi untuk status koneksi titik akhir privat saat ini string (diperlukan)
status Status koneksi titik akhir privat "Disetujui"
"Terputus"
"Tertunda"
"Ditolak" (diperlukan)

IotDpsSkuInfo

Nama Deskripsi Nilai
kapasitas Jumlah unit yang akan disediakan int
nama Nama Sku. "S1"