Iot Hub Resource - Update

Mevcut IoT Hubs etiketlerini güncelleştirin.
Mevcut IoT Hub etiketlerini güncelleştirin. Diğer alanları güncelleştirmek için CreateOrUpdate yöntemini kullanın

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
path True

string

Kaynak grubu tanımlayıcısı.

resourceName
path True

string

Güncelleştirilecek iot hub'ının adı.

subscriptionId
path True

string

Abonelik tanımlayıcısı.

api-version
query True

string

API sürümü.

İstek Gövdesi

Name Tür Description
tags

object

Kaynak etiketleri

Yanıtlar

Name Tür Description
200 OK

IotHubDescription

Iot Hub başarıyla güncelleştirildi

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

IotHubResource_Update

Örnek isteği

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/myHub?api-version=2023-06-30

{
  "tags": {
    "foo": "bar"
  }
}

Örnek yanıt

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {
    "foo": "bar"
  },
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Tanımlar

Name Description
AccessRights

Paylaşılan erişim ilkesine atanan izinler.

ArmIdentity
ArmUserIdentity
AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

authenticationType

Service Bus kuyruğu uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

Capabilities

IoT hub için etkinleştirilen özellikler ve özellikler.

CloudToDeviceProperties

IoT hub buluttan cihaza mesajlaşma özellikleri.

createdByType

Kaynağı oluşturan kimliğin türü.

DefaultAction

Ağ Kuralı Kümesi için Varsayılan Eylem

EnrichmentProperties

IoT hub'ınızın uç noktalara teslim edilen iletilere uyguladığı zenginleştirmenin özellikleri.

EventHubProperties

IoT hub'ı tarafından kullanılan sağlanan Event Hub uyumlu uç noktanın özellikleri.

FallbackRouteProperties

Geri dönüş yolunun özellikleri. IoT Hub, iletileri geri dönüş uç noktasına yönlendirirken bu özellikleri kullanır.

FeedbackProperties

Buluttan cihaza iletiler için geri bildirim kuyruğunun özellikleri.

IotHubDescription

IoT hub'ının açıklaması.

IotHubLocationDescription

Kaynağın sağlandığı konumlardan birinin genel gösterimi.

IotHubProperties

IoT hub'ının özellikleri.

IotHubReplicaRoleType

Bölgenin rolü birincil veya ikincil olabilir. Birincil bölge, IoT hub'unun şu anda sağlandığı bölgedir. İkincil bölge, Azure olağanüstü durum kurtarma (DR) eşleştirilmiş bölgesi ve ioT hub'ına yük devretmenin yapılabildiği bölgedir.

IotHubSku

SKU'nun adı.

IotHubSkuInfo

IoT hub'ının SKU'su hakkında bilgi.

IotHubSkuTier

IoT hub'ına yönelik faturalama katmanı.

IpFilterActionType

Bu kural tarafından yakalanan istekler için istenen eylem.

IpFilterRule

IoT hub'ına yönelik IP filtresi kuralları.

ManagedIdentity

Yönetilen kimliğin özellikleri.

MessagingEndpointProperties

Bu IoT hub'ı tarafından kullanılan mesajlaşma uç noktalarının özellikleri.

NetworkRuleIPAction

IP Filtresi Eylemi

NetworkRuleSetIpRule

Ağ Kuralı Kümesinin parçası olarak uygulanacak IP Kuralı

NetworkRuleSetProperties

IotHub'ın Ağ Kuralı Kümesi Özellikleri

PrivateEndpoint

Özel uç nokta bağlantısının özel uç nokta özelliği

PrivateEndpointConnection

IotHub'ın özel uç nokta bağlantısı

PrivateEndpointConnectionProperties

Özel uç nokta bağlantısının özellikleri

PrivateLinkServiceConnectionState

Özel uç nokta bağlantısının geçerli durumu

PrivateLinkServiceConnectionStatus

Özel uç nokta bağlantısının durumu

PublicNetworkAccess

Genel Ağdan gelen isteklere izin verilip verilmeyeceği

ResourceIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

RouteProperties

IoT hub'ınızın iletileri uç noktalara yönlendirmek için kullandığı yönlendirme kuralının özellikleri.

RoutingCosmosDBSqlApiProperties

Cosmos DB sql kapsayıcısı uç noktasıyla ilgili özellikler.

RoutingEndpoints

IoT hub'ınızın iletileri yönlendirme kurallarına göre yönlendirdiği özel uç noktalarla ilgili özellikler. Ücretli hub'lar için tüm uç nokta türlerinde en fazla 10 özel uç noktaya izin verilir ve ücretsiz hub'lar için tüm uç nokta türlerinde yalnızca 1 özel uç noktaya izin verilir.

RoutingEventHubProperties

Olay hub'ı uç noktasıyla ilgili özellikler.

RoutingProperties

IoT hub'ının yönlendirmeyle ilgili özellikleri. Bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Service Bus kuyruğu uç noktası türleriyle ilgili özellikler.

RoutingServiceBusTopicEndpointProperties

Service Bus konu uç noktası türleriyle ilgili özellikler.

RoutingSource

DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak.

RoutingStorageContainerProperties

Depolama kapsayıcısı uç noktasıyla ilgili özellikler.

SharedAccessSignatureAuthorizationRule

IoT hub paylaşılan erişim ilkesinin özellikleri.

StorageEndpointProperties

Dosya yükleme için Azure Depolama uç noktasının özellikleri.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

TagsResource

Kullanıcının bir IoT Hub örneğindeki etiketleri güncelleştirmesine olanak sağlayan, yalnızca bir kaynağın Etiketlerini tutan kapsayıcı.

AccessRights

Paylaşılan erişim ilkesine atanan izinler.

Name Tür Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ArmIdentity

Name Tür Description
principalId

string

Asıl Kimlik

tenantId

string

Kiracı Kimliği

type

ResourceIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Name Tür Description
clientId

string

principalId

string

AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

Name Tür Description
identityBased

string

keyBased

string

authenticationType

Service Bus kuyruğu uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

Name Tür Description
identityBased

string

keyBased

string

Capabilities

IoT hub için etkinleştirilen özellikler ve özellikler.

Name Tür Description
DeviceManagement

string

None

string

CloudToDeviceProperties

IoT hub buluttan cihaza mesajlaşma özellikleri.

Name Tür Description
defaultTtlAsIso8601

string

Cihaz kuyruğunda buluttan cihaza iletiler için varsayılan yaşam süresi. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

Buluttan cihaza iletiler için geri bildirim kuyruğunun özellikleri.

maxDeliveryCount

integer

Cihaz kuyruğundaki buluttan cihaza iletiler için maksimum teslim sayısı. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Ağ Kuralı Kümesi için Varsayılan Eylem

Name Tür Description
Allow

string

Deny

string

EnrichmentProperties

IoT hub'ınızın uç noktalara teslim edilen iletilere uyguladığı zenginleştirmenin özellikleri.

Name Tür Description
endpointNames

string[]

zenginleştirmenin iletiye uygulandığı uç noktaların listesi.

key

string

Zenginleştirme özelliğinin anahtarı veya adı.

value

string

Zenginleştirme özelliğinin değeri.

EventHubProperties

IoT hub'ı tarafından kullanılan sağlanan Event Hub uyumlu uç noktanın özellikleri.

Name Tür Description
endpoint

string

Event Hub ile uyumlu uç nokta.

partitionCount

integer

Event Hub ile uyumlu uç noktada cihazdan buluta iletileri almaya yönelik bölüm sayısı. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

Event Hub ile uyumlu uç noktadaki bölüm kimlikleri.

path

string

Olay Hub'ı ile uyumlu ad.

retentionTimeInDays

integer

Cihazdan buluta iletilerin saklama süresi (gün olarak). Bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Geri dönüş yolunun özellikleri. IoT Hub, iletileri geri dönüş uç noktasına yönlendirirken bu özellikleri kullanır.

Name Tür Description
condition

string

Geri dönüş yolunu uygulamak için değerlendirilen koşul. Koşul sağlanmazsa varsayılan olarak true olarak değerlendirilir. Dil bilgisi için bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Koşulu karşılayan iletilerin yönlendirildiği uç noktaların listesi. Şu anda yalnızca 1 uç noktaya izin verilir.

isEnabled

boolean

Geri dönüş yolunun etkinleştirilip etkinleştirilmediğini belirtmek için kullanılır.

name

string

Yolun adı. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir, en fazla 64 karakter uzunluğundadır ve benzersiz olmalıdır.

source

RoutingSource

Yönlendirme kuralının uygulanacağı kaynak. Örneğin, DeviceMessages

FeedbackProperties

Buluttan cihaza iletiler için geri bildirim kuyruğunun özellikleri.

Name Tür Description
lockDurationAsIso8601

string

Geri bildirim kuyruğunun kilit süresi. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer

IoT hub'ının geri bildirim kuyruğunda ileti göndermeyi deneme sayısı. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string

IoT hub'ı tarafından süresi dolmadan önce iletinin kullanılabilmesi için kullanılabilecek süre. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

IoT hub'ının açıklaması.

Name Tür Description
etag

string

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.

id

string

Kaynak tanımlayıcısı.

identity

ArmIdentity

IotHub için yönetilen kimlikler.

location

string

Kaynak konumu.

name

string

Kaynak adı.

properties

IotHubProperties

IotHub özellikleri

sku

IotHubSkuInfo

IotHub SKU bilgileri

systemData

systemData

Bu kaynakla ilgili sistem meta verileri.

tags

object

Kaynak etiketleri.

type

string

Kaynak türü.

IotHubLocationDescription

Kaynağın sağlandığı konumlardan birinin genel gösterimi.

Name Tür Description
location

string

Azure bölgesinin adı

role

IotHubReplicaRoleType

Bölgenin rolü birincil veya ikincil olabilir. Birincil bölge, IoT hub'unun şu anda sağlandığı bölgedir. İkincil bölge, Azure olağanüstü durum kurtarma (DR) eşleştirilmiş bölgesi ve ioT hub'ına yük devretmenin yapılabildiği bölgedir.

IotHubProperties

IoT hub'ının özellikleri.

Name Tür Description
allowedFqdnList

string[]

IoT Hub'dan çıkış için izin verilen FQDN'lerin (Tam Etki Alanı Adı) listesi.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

IoT hub'ına bir bağlantının güvenliğini sağlamak için kullanabileceğiniz paylaşılan erişim ilkeleri.

cloudToDevice

CloudToDeviceProperties

IoT hub buluttan cihaza mesajlaşma özellikleri.

comments

string

IoT hub açıklamaları.

disableDeviceSAS

boolean

Doğruysa, kimlik doğrulaması için tüm cihazlar (Edge cihazları dahil ancak modüller hariç) kapsamlı SAS anahtarları kullanılamaz.

disableLocalAuth

boolean

Doğruysa, iot hub'ı kapsamlı SAS anahtarları olan SAS belirteçleri kimlik doğrulaması için kullanılamaz.

disableModuleSAS

boolean

True ise, tüm modül kapsamlı SAS anahtarları kimlik doğrulaması için kullanılamaz.

enableDataResidency

boolean

Bu özellik true olarak ayarlandığında veri yerleşimini etkinleştirerek olağanüstü durum kurtarmayı devre dışı bırakır.

enableFileUploadNotifications

boolean

True ise, dosya karşıya yükleme bildirimleri etkinleştirilir.

eventHubEndpoints

<string,  EventHubProperties>

Event Hub uyumlu uç nokta özellikleri. Bu sözlüğün tek olası anahtarları olaylardır. Bu anahtarın, IoT hub'ı için oluşturma veya güncelleştirme çağrıları yapılırken sözlükte bulunması gerekir.

features

Capabilities

IoT hub için etkinleştirilen özellikler ve özellikler.

hostName

string

Ana bilgisayarın adı.

ipFilterRules

IpFilterRule[]

IP filtresi kuralları.

locations

IotHubLocationDescription[]

IoT hub'ı için birincil ve ikincil konum

messagingEndpoints

<string,  MessagingEndpointProperties>

Dosya karşıya yükleme bildirim kuyruğu için mesajlaşma uç noktası özellikleri.

minTlsVersion

string

Bu hub için destek için en düşük TLS sürümünü belirtir. 1.2'nin altındaki bir TLS sürümünü kullanan istemcilerin reddedilmesi için "1.2" olarak ayarlanabilir.

networkRuleSets

NetworkRuleSetProperties

IotHub'ın Ağ Kuralı Kümesi Özellikleri

privateEndpointConnections

PrivateEndpointConnection[]

Bu IotHub'da oluşturulan özel uç nokta bağlantıları

provisioningState

string

Sağlama durumu.

publicNetworkAccess

PublicNetworkAccess

Genel Ağdan gelen isteklere izin verilip verilmeyeceği

restrictOutboundNetworkAccess

boolean

Doğruysa, IotHub'dan çıkış yalnızca allowedFqdnList aracılığıyla yapılandırılan izin verilen FQDN'lerle kısıtlanır.

routing

RoutingProperties

IoT hub'ının yönlendirmeyle ilgili özellikleri. Bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

Merkez durumu.

storageEndpoints

<string,  StorageEndpointProperties>

Dosyaları karşıya yükleyebileceğiniz Azure Depolama uç noktalarının listesi. Şu anda yalnızca bir Azure Depolama hesabı yapılandırabilirsiniz ve bu hesabın anahtarı $default olmalıdır. Birden fazla depolama hesabı belirtilmesi hata oluşmasına neden olur. enableFileUploadNotifications özelliği True olarak ayarlandığında bu özellik için bir değer belirtilmemesi, hata oluşmasına neden olur.

IotHubReplicaRoleType

Bölgenin rolü birincil veya ikincil olabilir. Birincil bölge, IoT hub'unun şu anda sağlandığı bölgedir. İkincil bölge, Azure olağanüstü durum kurtarma (DR) eşleştirilmiş bölgesi ve ioT hub'ına yük devretmenin yapılabildiği bölgedir.

Name Tür Description
primary

string

secondary

string

IotHubSku

SKU'nun adı.

Name Tür Description
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

IoT hub'ının SKU'su hakkında bilgi.

Name Tür Description
capacity

integer

Sağlanan IoT Hub birim sayısı. Bkz. https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

SKU'nun adı.

tier

IotHubSkuTier

IoT hub'ına yönelik faturalama katmanı.

IotHubSkuTier

IoT hub'ına yönelik faturalama katmanı.

Name Tür Description
Basic

string

Free

string

Standard

string

IpFilterActionType

Bu kural tarafından yakalanan istekler için istenen eylem.

Name Tür Description
Accept

string

Reject

string

IpFilterRule

IoT hub'ına yönelik IP filtresi kuralları.

Name Tür Description
action

IpFilterActionType

Bu kural tarafından yakalanan istekler için istenen eylem.

filterName

string

IP filtresi kuralının adı.

ipMask

string

Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize.

ManagedIdentity

Yönetilen kimliğin özellikleri.

Name Tür Description
userAssignedIdentity

string

Kullanıcı tarafından atanan kimlik.

MessagingEndpointProperties

Bu IoT hub'ı tarafından kullanılan mesajlaşma uç noktalarının özellikleri.

Name Tür Description
lockDurationAsIso8601

string

Kilit süresi. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer

IoT hub'ının ileti teslim etmeye çalışma sayısı. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string

IoT hub'ı tarafından süresi dolmadan önce iletinin kullanılabilmesi için kullanılabilecek süre. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

IP Filtresi Eylemi

Name Tür Description
Allow

string

NetworkRuleSetIpRule

Ağ Kuralı Kümesinin parçası olarak uygulanacak IP Kuralı

Name Tür Default value Description
action

NetworkRuleIPAction

Allow

IP Filtresi Eylemi

filterName

string

IP filtresi kuralının adı.

ipMask

string

Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize.

NetworkRuleSetProperties

IotHub'ın Ağ Kuralı Kümesi Özellikleri

Name Tür Default value Description
applyToBuiltInEventHubEndpoint

boolean

True ise Ağ Kuralı Kümesi, IotHub'ın BuiltIn EventHub EndPoint'ine de uygulanır

defaultAction

DefaultAction

Deny

Ağ Kuralı Kümesi için Varsayılan Eylem

ipRules

NetworkRuleSetIpRule[]

IP Kuralları Listesi

PrivateEndpoint

Özel uç nokta bağlantısının özel uç nokta özelliği

Name Tür Description
id

string

Kaynak tanımlayıcısı.

PrivateEndpointConnection

IotHub'ın özel uç nokta bağlantısı

Name Tür Description
id

string

Kaynak tanımlayıcısı.

name

string

Kaynak adı.

properties

PrivateEndpointConnectionProperties

Özel uç nokta bağlantısının özellikleri

type

string

Kaynak türü.

PrivateEndpointConnectionProperties

Özel uç nokta bağlantısının özellikleri

Name Tür Description
privateEndpoint

PrivateEndpoint

Özel uç nokta bağlantısının özel uç nokta özelliği

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Özel uç nokta bağlantısının geçerli durumu

PrivateLinkServiceConnectionState

Özel uç nokta bağlantısının geçerli durumu

Name Tür Description
actionsRequired

string

Özel uç nokta bağlantısı için gereken eylemler

description

string

Özel uç nokta bağlantısının geçerli durumunun açıklaması

status

PrivateLinkServiceConnectionStatus

Özel uç nokta bağlantısının durumu

PrivateLinkServiceConnectionStatus

Özel uç nokta bağlantısının durumu

Name Tür Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Genel Ağdan gelen isteklere izin verilip verilmeyeceği

Name Tür Description
Disabled

string

Enabled

string

ResourceIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

Name Tür Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

IoT hub'ınızın iletileri uç noktalara yönlendirmek için kullandığı yönlendirme kuralının özellikleri.

Name Tür Description
condition

string

Yönlendirme kuralını uygulamak için değerlendirilen koşul. Koşul sağlanmazsa, varsayılan olarak true olarak değerlendirilir. Dil bilgisi için bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Koşulu karşılayan iletilerin yönlendirildiği uç noktaların listesi. Şu anda yalnızca bir uç noktaya izin verilir.

isEnabled

boolean

Bir yolun etkinleştirilip etkinleştirilmediğini belirtmek için kullanılır.

name

string

Yolun adı. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir, en fazla 64 karakter uzunluğundadır ve benzersiz olmalıdır.

source

RoutingSource

DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak.

RoutingCosmosDBSqlApiProperties

Cosmos DB sql kapsayıcısı uç noktasıyla ilgili özellikler.

Name Tür Description
authenticationType

authenticationType

Cosmos DB sql kapsayıcı uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

containerName

string

Cosmos DB veritabanındaki cosmos DB sql kapsayıcısının adı.

databaseName

string

Cosmos DB hesabındaki cosmos DB veritabanının adı.

endpointUri

string

Cosmos DB hesabının URL'si. Protokol https:// içermelidir

id

string

Cosmos DB sql kapsayıcı uç noktasının kimliği

identity

ManagedIdentity

Cosmos DB kapsayıcı uç noktasını yönlendirmenin yönetilen kimlik özellikleri.

name

string

Bu uç noktayı tanımlayan ad. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir ve uzunluk üst sınırı 64 karakterdir. Aşağıdaki adlar ayrılmıştır: olaylar, fileNotifications, $default. Uç nokta adları, uç nokta türleri arasında benzersiz olmalıdır.

partitionKeyName

string

Varsa, bu cosmos DB sql kapsayıcısıyla ilişkili bölüm anahtarının adı. Bu isteğe bağlı bir parametredir.

partitionKeyTemplate

string

Bu cosmos DB sql kapsayıcısıyla kullanılmak üzere yapay bölüm anahtarı değeri oluşturmaya yönelik şablon. Şablon aşağıdaki yer tutuculardan en az birini içermelidir: {iothub}, {deviceid}, {DD}, {MM}ve {YYYY}. Herhangi bir yer tutucu en fazla bir kez belirtilebilir, ancak sıra ve yer tutucu olmayan bileşenler rastgeledir. Bu parametre yalnızca PartitionKeyName belirtilirse gereklidir.

primaryKey

string

Cosmos DB hesabının birincil anahtarı.

resourceGroup

string

Cosmos DB hesabının kaynak grubunun adı.

secondaryKey

string

Cosmos DB hesabının ikincil anahtarı.

subscriptionId

string

Cosmos DB hesabının abonelik tanımlayıcısı.

RoutingEndpoints

IoT hub'ınızın iletileri yönlendirme kurallarına göre yönlendirdiği özel uç noktalarla ilgili özellikler. Ücretli hub'lar için tüm uç nokta türlerinde en fazla 10 özel uç noktaya izin verilir ve ücretsiz hub'lar için tüm uç nokta türlerinde yalnızca 1 özel uç noktaya izin verilir.

Name Tür Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

Yönlendirme kurallarına göre IoT hub'ının iletileri yönlendirdığı Cosmos DB kapsayıcı uç noktalarının listesi.

eventHubs

RoutingEventHubProperties[]

Yönlendirme kurallarına göre IoT hub'ının iletileri yönlendirdığı Event Hubs uç noktalarının listesi. Bu liste, yerleşik Event Hubs uç noktasını içermez.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

Yönlendirme kurallarına göre IoT hub'ının iletileri yönlendirdığı Service Bus kuyruk uç noktalarının listesi.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Yönlendirme kurallarına göre IoT hub'ının iletileri yönlendirdığı Service Bus konu uç noktalarının listesi.

storageContainers

RoutingStorageContainerProperties[]

Yönlendirme kurallarına göre IoT hub'ının iletileri yönlendirdığı depolama kapsayıcısı uç noktalarının listesi.

RoutingEventHubProperties

Olay hub'ı uç noktasıyla ilgili özellikler.

Name Tür Description
authenticationType

authenticationType

Olay hub'ı uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

connectionString

string

Olay hub'ı uç noktasının bağlantı dizesi.

endpointUri

string

Olay hub'ı uç noktasının URL'si. Protokol sb:// içermelidir

entityPath

string

Olay hub'ı ad alanındaki olay hub'ı adı

id

string

Olay hub'ı uç noktasının kimliği

identity

ManagedIdentity

Olay hub'ı uç noktasını yönlendirmenin yönetilen kimlik özellikleri.

name

string

Bu uç noktayı tanımlayan ad. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir ve uzunluk üst sınırı 64 karakterdir. Aşağıdaki adlar ayrılmıştır: olaylar, fileNotifications, $default. Uç nokta adları, uç nokta türleri arasında benzersiz olmalıdır.

resourceGroup

string

Olay hub'ı uç noktasının kaynak grubunun adı.

subscriptionId

string

Olay hub'ı uç noktasının abonelik tanımlayıcısı.

RoutingProperties

IoT hub'ının yönlendirmeyle ilgili özellikleri. Bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name Tür Description
endpoints

RoutingEndpoints

IoT hub'ınızın iletileri yönlendirme kurallarına göre yönlendirdiği özel uç noktalarla ilgili özellikler. Ücretli hub'lar için tüm uç nokta türlerinde en fazla 10 özel uç noktaya izin verilir ve ücretsiz hub'lar için tüm uç nokta türlerinde yalnızca 1 özel uç noktaya izin verilir.

enrichments

EnrichmentProperties[]

IoT hub'ının yerleşik ve özel uç noktalara teslim edilecek iletilere uyguladığı, kullanıcı tarafından sağlanan zenginleştirmelerin listesi. Bkz: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

'Routes' bölümünde belirtilen koşulların hiçbiri karşılanmadığında geri dönüş yolu olarak kullanılan yolun özellikleri. Bu isteğe bağlı bir parametredir. Bu özellik şablonda mevcut olmadığında, geri dönüş yolu varsayılan olarak devre dışı bırakılır.

routes

RouteProperties[]

IoT hub'ının iletileri yerleşik ve özel uç noktalara yönlendirmek için kullandığı kullanıcı tarafından sağlanan yönlendirme kurallarının listesi. Ücretli hub'lar için en fazla 100 yönlendirme kuralına ve ücretsiz hub'lar için en fazla 5 yönlendirme kuralına izin verilir.

RoutingServiceBusQueueEndpointProperties

Service Bus kuyruğu uç noktası türleriyle ilgili özellikler.

Name Tür Description
authenticationType

authenticationType

Service Bus kuyruğu uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

connectionString

string

Service Bus kuyruğu uç noktasının bağlantı dizesi.

endpointUri

string

Service Bus kuyruğu uç noktasının URL'si. Protokol sb:// içermelidir

entityPath

string

Service Bus ad alanında kuyruk adı

id

string

Service Bus kuyruğu uç noktasının kimliği

identity

ManagedIdentity

Yönlendirme hizmeti veri yolu kuyruğu uç noktasının yönetilen kimlik özellikleri.

name

string

Bu uç noktayı tanımlayan ad. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir ve uzunluk üst sınırı 64 karakterdir. Aşağıdaki adlar ayrılmıştır: olaylar, fileNotifications, $default. Uç nokta adları, uç nokta türleri arasında benzersiz olmalıdır. Adın gerçek kuyruk adıyla aynı olması gerekmez.

resourceGroup

string

Service Bus kuyruğu uç noktasının kaynak grubunun adı.

subscriptionId

string

Service Bus kuyruğu uç noktasının abonelik tanımlayıcısı.

RoutingServiceBusTopicEndpointProperties

Service Bus konu uç noktası türleriyle ilgili özellikler.

Name Tür Description
authenticationType

authenticationType

Service Bus konu uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

connectionString

string

Service Bus konu uç noktasının bağlantı dizesi.

endpointUri

string

Service Bus konu uç noktasının URL'si. Protokol sb:// içermelidir

entityPath

string

Service Bus konusunda kuyruk adı

id

string

Service Bus konu uç noktasının kimliği

identity

ManagedIdentity

Yönlendirme hizmeti veri yolu konu uç noktasının yönetilen kimlik özellikleri.

name

string

Bu uç noktayı tanımlayan ad. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir ve uzunluk üst sınırı 64 karakterdir. Aşağıdaki adlar ayrılmıştır: olaylar, fileNotifications, $default. Uç nokta adları, uç nokta türleri arasında benzersiz olmalıdır. Adın gerçek konu adıyla aynı olması gerekmez.

resourceGroup

string

Service Bus konu uç noktasının kaynak grubunun adı.

subscriptionId

string

Service Bus konu uç noktasının abonelik tanımlayıcısı.

RoutingSource

DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak.

Name Tür Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

Depolama kapsayıcısı uç noktasıyla ilgili özellikler.

Name Tür Description
authenticationType

authenticationType

Depolama uç noktasında kimlik doğrulaması yapmak için kullanılan yöntem

batchFrequencyInSeconds

integer

Blobların depolamaya yazıldığı zaman aralığı. Değer 60 ile 720 saniye arasında olmalıdır. Varsayılan değer 300 saniyedir.

connectionString

string

Depolama hesabının bağlantı dizesi.

containerName

string

Depolama hesabındaki depolama kapsayıcısının adı.

encoding enum:
  • Avro
  • AvroDeflate
  • JSON

İletileri bloblara seri hale getirmek için kullanılan kodlama. Desteklenen değerler :'avro', 'avrodeflate' ve 'JSON'. Varsayılan değer :'avro'.

endpointUri

string

Depolama uç noktasının URL'si. Protokol https:// içermelidir

fileNameFormat

string

Blob için dosya adı biçimi. Varsayılan biçim: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Tüm parametreler zorunlu olsa da yeniden sıralanabilir.

id

string

Depolama kapsayıcısı uç noktasının kimliği

identity

ManagedIdentity

Depolama uç noktasını yönlendirmenin yönetilen kimlik özellikleri.

maxChunkSizeInBytes

integer

Depolama alanına yazılan her blob için maksimum bayt sayısı. Değer 10485760(10 MB) ile 524288000(500 MB) arasında olmalıdır. Varsayılan değer 314572800(300 MB) değeridir.

name

string

Bu uç noktayı tanımlayan ad. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir ve uzunluk üst sınırı 64 karakterdir. Aşağıdaki adlar ayrılmıştır: olaylar, fileNotifications, $default. Uç nokta adları, uç nokta türleri arasında benzersiz olmalıdır.

resourceGroup

string

Depolama hesabının kaynak grubunun adı.

subscriptionId

string

Depolama hesabının abonelik tanımlayıcısı.

SharedAccessSignatureAuthorizationRule

IoT hub paylaşılan erişim ilkesinin özellikleri.

Name Tür Description
keyName

string

Paylaşılan erişim ilkesinin adı.

primaryKey

string

Birincil anahtar.

rights

AccessRights

Paylaşılan erişim ilkesine atanan izinler.

secondaryKey

string

İkincil anahtar.

StorageEndpointProperties

Dosya yükleme için Azure Depolama uç noktasının özellikleri.

Name Tür Description
authenticationType

AuthenticationType

Depolama hesabına bağlanmak için kullanılan kimlik doğrulama türünü belirtir.

connectionString

string

Dosyaların karşıya yüklendiği Azure Depolama hesabının bağlantı dizesi.

containerName

string

Dosyaları karşıya yüklediğiniz kök kapsayıcının adı. Kapsayıcı mevcut değil, ancak belirtilen connectionString kullanılarak oluşturulabilir olmalıdır.

identity

ManagedIdentity

Dosya yükleme için depolama uç noktasının yönetilen kimlik özellikleri.

sasTtlAsIso8601

string

Dosya yükleme için IoT Hub tarafından oluşturulan SAS URI'sinin geçerli olduğu süre. Bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

TagsResource

Kullanıcının bir IoT Hub örneğindeki etiketleri güncelleştirmesine olanak sağlayan, yalnızca bir kaynağın Etiketlerini tutan kapsayıcı.

Name Tür Description
tags

object

Kaynak etiketleri