다음을 통해 공유

Iot Hub Resource - Update

  • 참조
서비스:
IoT Hub
API 버전:
2023-06-30

기존 IoT Hubs 태그를 업데이트합니다.
기존 IoT Hub 태그를 업데이트합니다. 다른 필드를 업데이트하려면 CreateOrUpdate 메서드를 사용합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
 path True

string

리소스 그룹 식별자입니다.
resourceName
 path True

string

업데이트할 iot 허브의 이름입니다.
subscriptionId
 path True

string

구독 식별자입니다.
api-version
 query True

string

API 버전입니다.

요청 본문

Name 형식 Description
tags

object

리소스 태그

응답

Name 형식 Description
200 OK

IotHubDescription

IoT Hub가 성공적으로 업데이트되었습니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

IotHubResource_Update

샘플 요청

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

샘플 응답

상태 코드:
200 
{
  "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"
  }
}

정의

Name Description
AccessRights

공유 액세스 정책에 할당된 권한입니다.
ArmIdentity
ArmUserIdentity
AuthenticationType

스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.
authenticationType

Service Bus 큐 엔드포인트에 대해 인증하는 데 사용되는 메서드
Capabilities

IoT Hub에 대해 사용하도록 설정된 기능 및 기능입니다.
CloudToDeviceProperties

IoT Hub 클라우드-디바이스 메시징 속성입니다.
createdByType

리소스를 만든 ID 유형입니다.
DefaultAction

네트워크 규칙 집합에 대한 기본 작업
EnrichmentProperties

IoT Hub가 엔드포인트에 전달되는 메시지에 적용되는 보강의 속성입니다.
EventHubProperties

IoT Hub에서 사용하는 프로비전된 Event Hub 호환 엔드포인트의 속성입니다.
FallbackRouteProperties

대체 경로의 속성입니다. IoT Hub 대체 엔드포인트로 메시지를 라우팅할 때 이러한 속성을 사용합니다.
FeedbackProperties

클라우드-디바이스 메시지에 대한 피드백 큐의 속성입니다.
IotHubDescription

IoT Hub에 대한 설명입니다.
IotHubLocationDescription

리소스가 프로비전되는 위치 중 하나의 공용 표현입니다.
IotHubProperties

IoT Hub의 속성입니다.
IotHubReplicaRoleType

지역의 역할은 주 또는 보조 역할일 수 있습니다. 주 지역은 IoT Hub가 현재 프로비전된 위치입니다. 보조 지역은 DR(Azure 재해 복구) 쌍을 이루는 지역이며 IoT Hub가 장애 조치(failover)할 수 있는 지역이기도 합니다.
IotHubSku

SKU의 이름입니다.
IotHubSkuInfo

IoT Hub의 SKU에 대한 정보입니다.
IotHubSkuTier

IoT Hub에 대한 청구 계층입니다.
IpFilterActionType

이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.
IpFilterRule

IoT Hub에 대한 IP 필터 규칙입니다.
ManagedIdentity

관리 ID의 속성입니다.
MessagingEndpointProperties

이 IoT Hub에서 사용하는 메시징 엔드포인트의 속성입니다.
NetworkRuleIPAction

IP 필터 작업
NetworkRuleSetIpRule

네트워크 규칙 집합의 일부로 적용할 IP 규칙
NetworkRuleSetProperties

IotHub의 네트워크 규칙 집합 속성
PrivateEndpoint

프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성
PrivateEndpointConnection

IotHub의 프라이빗 엔드포인트 연결
PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성
PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 현재 상태
PrivateLinkServiceConnectionStatus

프라이빗 엔드포인트 연결의 상태
PublicNetworkAccess

공용 네트워크의 요청 허용 여부
ResourceIdentityType

리소스에 사용되는 ID 유형입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 ID를 제거합니다.
RouteProperties

IoT Hub가 메시지를 엔드포인트로 라우팅하는 데 사용하는 라우팅 규칙의 속성입니다.
RoutingCosmosDBSqlApiProperties

cosmos DB sql 컨테이너 엔드포인트와 관련된 속성입니다.
RoutingEndpoints

IoT Hub가 라우팅 규칙에 따라 메시지를 라우팅하는 사용자 지정 엔드포인트와 관련된 속성입니다. 유료 허브의 모든 엔드포인트 유형에서 최대 10개의 사용자 지정 엔드포인트가 허용되며 무료 허브의 모든 엔드포인트 유형에서 1개의 사용자 지정 엔드포인트만 허용됩니다.
RoutingEventHubProperties

이벤트 허브 엔드포인트와 관련된 속성입니다.
RoutingProperties

IoT Hub의 라우팅 관련 속성입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging을 참조하세요.
RoutingServiceBusQueueEndpointProperties

Service Bus 큐 엔드포인트 유형과 관련된 속성입니다.
RoutingServiceBusTopicEndpointProperties

Service Bus 토픽 엔드포인트 유형과 관련된 속성입니다.
RoutingSource

DeviceMessages와 같이 라우팅 규칙을 적용할 원본입니다.
RoutingStorageContainerProperties

스토리지 컨테이너 엔드포인트와 관련된 속성입니다.
SharedAccessSignatureAuthorizationRule

IoT Hub 공유 액세스 정책의 속성입니다.
StorageEndpointProperties

파일 업로드를 위한 Azure Storage 엔드포인트의 속성입니다.
systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
TagsResource

리소스에 대한 태그만 보유하는 컨테이너로, 사용자가 IoT Hub instance 태그를 업데이트할 수 있습니다.

AccessRights

공유 액세스 정책에 할당된 권한입니다.

Name 형식 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 형식 Description
principalId

string

보안 주체 ID
tenantId

string

테넌트 ID
type

ResourceIdentityType

리소스에 사용되는 ID 유형입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 ID를 제거합니다.
userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Name 형식 Description
clientId

string

principalId

string

AuthenticationType

스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.

Name 형식 Description
identityBased

string

keyBased

string

authenticationType

Service Bus 큐 엔드포인트에 대해 인증하는 데 사용되는 메서드

Name 형식 Description
identityBased

string

keyBased

string

Capabilities

IoT Hub에 대해 사용하도록 설정된 기능 및 기능입니다.

Name 형식 Description
DeviceManagement

string

None

string

CloudToDeviceProperties

IoT Hub 클라우드-디바이스 메시징 속성입니다.

Name 형식 Description
defaultTtlAsIso8601

string

디바이스 큐의 클라우드-디바이스 메시지에 대한 기본 라이브 시간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages를 참조하세요.
feedback

FeedbackProperties

클라우드-디바이스 메시지에 대한 피드백 큐의 속성입니다.
maxDeliveryCount

integer

디바이스 큐의 클라우드-디바이스 메시지에 대한 최대 배달 수입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages를 참조하세요.

createdByType

리소스를 만든 ID 유형입니다.

Name 형식 Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

네트워크 규칙 집합에 대한 기본 작업

Name 형식 Description
Allow

string

Deny

string

EnrichmentProperties

IoT Hub가 엔드포인트에 전달되는 메시지에 적용되는 보강의 속성입니다.

Name 형식 Description
endpointNames

string[]

보강이 메시지에 적용되는 엔드포인트 목록입니다.
key

string

보강 속성의 키 또는 이름입니다.
value

string

보강 속성의 값입니다.

EventHubProperties

IoT Hub에서 사용하는 프로비전된 Event Hub 호환 엔드포인트의 속성입니다.

Name 형식 Description
endpoint

string

Event Hub 호환 엔드포인트입니다.
partitionCount

integer

Event Hub 호환 엔드포인트에서 디바이스-클라우드 메시지를 수신하기 위한 파티션 수입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages를 참조하세요.
partitionIds

string[]

Event Hub 호환 엔드포인트의 파티션 ID입니다.
path

string

Event Hub 호환 이름입니다.
retentionTimeInDays

integer

디바이스-클라우드 메시지의 보존 시간(일)입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages을 참조하세요.

FallbackRouteProperties

대체 경로의 속성입니다. IoT Hub 대체 엔드포인트로 메시지를 라우팅할 때 이러한 속성을 사용합니다.

Name 형식 Description
condition

string

대체 경로를 적용하기 위해 평가되는 조건입니다. 조건이 제공되지 않으면 기본적으로 true로 평가됩니다. 문법은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

조건을 충족하는 메시지가 라우팅되는 엔드포인트 목록입니다. 현재 1개 엔드포인트만 허용됩니다.
isEnabled

boolean

대체 경로의 사용 여부를 지정하는 데 사용됩니다.
name

string

경로의 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자이며 고유해야 합니다.
source

RoutingSource

라우팅 규칙을 적용할 원본입니다. 예를 들어 DeviceMessages

FeedbackProperties

클라우드-디바이스 메시지에 대한 피드백 큐의 속성입니다.

Name 형식 Description
lockDurationAsIso8601

string

피드백 큐의 잠금 기간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages를 참조하세요.
maxDeliveryCount

integer

IoT Hub가 피드백 큐에 메시지를 배달하려고 시도하는 횟수입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages를 참조하세요.
ttlAsIso8601

string

IoT Hub에서 만료되기 전에 메시지를 사용할 수 있는 기간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages를 참조하세요.

IotHubDescription

IoT Hub에 대한 설명입니다.

Name 형식 Description
etag

string

Etag 필드는 필요하지 않습니다 . 응답 본문에 제공된 경우 일반적인 ETag 규칙에 따라 헤더로도 제공해야 합니다.
id

string

리소스 식별자입니다.
identity

ArmIdentity

IotHub의 관리 ID입니다.
location

string

리소스 위치입니다.
name

string

리소스 이름입니다.
properties

IotHubProperties

IotHub 속성
sku

IotHubSkuInfo

IotHub SKU 정보
systemData

systemData

이 리소스와 관련된 시스템 메타 데이터입니다.
tags

object

리소스 태그입니다.
type

string

리소스 종류입니다.

IotHubLocationDescription

리소스가 프로비전되는 위치 중 하나의 공용 표현입니다.

Name 형식 Description
location

string

Azure 지역의 이름
role

IotHubReplicaRoleType

지역의 역할은 주 또는 보조 역할일 수 있습니다. 주 지역은 IoT Hub가 현재 프로비전된 위치입니다. 보조 지역은 DR(Azure 재해 복구) 쌍을 이루는 지역이며 IoT Hub가 장애 조치(failover)할 수 있는 지역이기도 합니다.

IotHubProperties

IoT Hub의 속성입니다.

Name 형식 Description
allowedFqdnList

string[]

Iot Hub에서 송신할 수 있는 FQDN(정규화된 도메인 이름) 목록입니다.
authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

IoT Hub에 대한 연결을 보호하는 데 사용할 수 있는 공유 액세스 정책입니다.
cloudToDevice

CloudToDeviceProperties

IoT Hub 클라우드-디바이스 메시징 속성입니다.
comments

string

IoT Hub 주석.
disableDeviceSAS

boolean

true이면 모든 디바이스(Edge 디바이스를 포함하지만 모듈 제외) 범위 SAS 키는 인증에 사용할 수 없습니다.
disableLocalAuth

boolean

true이면 IoT Hub 범위 SAS 키가 있는 SAS 토큰을 인증에 사용할 수 없습니다.
disableModuleSAS

boolean

true이면 모든 모듈 범위 SAS 키를 인증에 사용할 수 없습니다.
enableDataResidency

boolean

true로 설정된 경우 이 속성은 데이터 보존을 사용하도록 설정하므로 재해 복구를 사용하지 않도록 설정합니다.
enableFileUploadNotifications

boolean

True이면 파일 업로드 알림이 활성화됩니다.
eventHubEndpoints

<string,  EventHubProperties>

Event Hub 호환 엔드포인트 속성입니다. 이 사전에 사용할 수 있는 유일한 키는 이벤트입니다. 이 키는 IoT Hub에 대한 호출을 만들거나 업데이트하는 동안 사전에 있어야 합니다.
features

Capabilities

IoT Hub에 대해 사용하도록 설정된 기능 및 기능입니다.
hostName

string

호스트의 이름입니다.
ipFilterRules

IpFilterRule[]

IP 필터 규칙입니다.
locations

IotHubLocationDescription[]

IoT Hub에 대한 기본 및 보조 위치
messagingEndpoints

<string,  MessagingEndpointProperties>

파일 업로드 알림 큐에 대한 메시징 엔드포인트 속성입니다.
minTlsVersion

string

이 허브에 대해 지원할 최소 TLS 버전을 지정합니다. 1.2 미만의 TLS 버전을 사용하는 클라이언트가 거부되도록 하려면 "1.2"로 설정할 수 있습니다.
networkRuleSets

NetworkRuleSetProperties

IotHub의 네트워크 규칙 집합 속성
privateEndpointConnections

PrivateEndpointConnection[]

이 IotHub에서 만든 프라이빗 엔드포인트 연결
provisioningState

string

프로비저닝 상태입니다.
publicNetworkAccess

PublicNetworkAccess

공용 네트워크의 요청 허용 여부
restrictOutboundNetworkAccess

boolean

true이면 IotHub의 송신은 allowedFqdnList를 통해 구성된 허용된 FQDN으로만 제한됩니다.
routing

RoutingProperties

IoT Hub의 라우팅 관련 속성입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging을 참조하세요.
state

string

허브 상태입니다.
storageEndpoints

<string,  StorageEndpointProperties>

파일을 업로드할 수 있는 Azure Storage 엔드포인트 목록입니다. 현재는 하나의 Azure Storage 계정만 구성할 수 있으며 해당 키는 $default. 둘 이상의 스토리지 계정을 지정하면 오류가 throw됩니다. enableFileUploadNotifications 속성이 True로 설정된 경우 이 속성의 값을 지정하지 않으면 오류가 발생합니다.

IotHubReplicaRoleType

지역의 역할은 주 또는 보조 역할일 수 있습니다. 주 지역은 IoT Hub가 현재 프로비전된 위치입니다. 보조 지역은 DR(Azure 재해 복구) 쌍을 이루는 지역이며 IoT Hub가 장애 조치(failover)할 수 있는 지역이기도 합니다.

Name 형식 Description
primary

string

secondary

string

IotHubSku

SKU의 이름입니다.

Name 형식 Description
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

IoT Hub의 SKU에 대한 정보입니다.

Name 형식 Description
capacity

integer

프로비전된 IoT Hub 단위의 수입니다. https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits를 참조하세요.
name

IotHubSku

SKU의 이름입니다.
tier

IotHubSkuTier

IoT Hub에 대한 청구 계층입니다.

IotHubSkuTier

IoT Hub에 대한 청구 계층입니다.

Name 형식 Description
Basic

string

Free

string

Standard

string

IpFilterActionType

이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.

Name 형식 Description
Accept

string

Reject

string

IpFilterRule

IoT Hub에 대한 IP 필터 규칙입니다.

Name 형식 Description
action

IpFilterActionType

이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.
filterName

string

IP 필터 규칙의 이름입니다.
ipMask

string

규칙에 대한 CIDR 표기법의 IP 주소 범위를 포함하는 문자열입니다.

ManagedIdentity

관리 ID의 속성입니다.

Name 형식 Description
userAssignedIdentity

string

사용자 할당 ID입니다.

MessagingEndpointProperties

이 IoT Hub에서 사용하는 메시징 엔드포인트의 속성입니다.

Name 형식 Description
lockDurationAsIso8601

string

잠금 기간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload를 참조하세요.
maxDeliveryCount

integer

IoT Hub가 메시지를 배달하려고 시도하는 횟수입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload를 참조하세요.
ttlAsIso8601

string

IoT Hub에서 만료되기 전에 메시지를 사용할 수 있는 기간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload를 참조하세요.

NetworkRuleIPAction

IP 필터 작업

Name 형식 Description
Allow

string

NetworkRuleSetIpRule

네트워크 규칙 집합의 일부로 적용할 IP 규칙

Name 형식 Default value Description
action

NetworkRuleIPAction

Allow

IP 필터 작업
filterName

string

IP 필터 규칙의 이름입니다.
ipMask

string

규칙에 대한 CIDR 표기법의 IP 주소 범위를 포함하는 문자열입니다.

NetworkRuleSetProperties

IotHub의 네트워크 규칙 집합 속성

Name 형식 Default value Description
applyToBuiltInEventHubEndpoint

boolean

True이면 네트워크 규칙 집합이 IotHub의 BuiltIn EventHub 엔드포인트에도 적용됩니다.
defaultAction

DefaultAction

Deny

네트워크 규칙 집합에 대한 기본 작업
ipRules

NetworkRuleSetIpRule[]

IP 규칙 목록

PrivateEndpoint

프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성

Name 형식 Description
id

string

리소스 식별자입니다.

PrivateEndpointConnection

IotHub의 프라이빗 엔드포인트 연결

Name 형식 Description
id

string

리소스 식별자입니다.
name

string

리소스 이름입니다.
properties

PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성
type

string

리소스 종류입니다.

PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성

Name 형식 Description
privateEndpoint

PrivateEndpoint

프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 현재 상태

PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 현재 상태

Name 형식 Description
actionsRequired

string

프라이빗 엔드포인트 연결에 필요한 작업
description

string

프라이빗 엔드포인트 연결의 현재 상태에 대한 설명
status

PrivateLinkServiceConnectionStatus

프라이빗 엔드포인트 연결의 상태

PrivateLinkServiceConnectionStatus

프라이빗 엔드포인트 연결의 상태

Name 형식 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

공용 네트워크의 요청 허용 여부

Name 형식 Description
Disabled

string

Enabled

string

ResourceIdentityType

리소스에 사용되는 ID 유형입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 ID를 제거합니다.

Name 형식 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

IoT Hub가 메시지를 엔드포인트로 라우팅하는 데 사용하는 라우팅 규칙의 속성입니다.

Name 형식 Description
condition

string

라우팅 규칙을 적용하기 위해 평가되는 조건입니다. 조건이 제공되지 않으면 기본적으로 true로 평가됩니다. 문법은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

조건을 충족하는 메시지가 라우팅되는 엔드포인트 목록입니다. 현재 하나의 엔드포인트만 허용됩니다.
isEnabled

boolean

경로를 사용할지 여부를 지정하는 데 사용됩니다.
name

string

경로의 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자이며 고유해야 합니다.
source

RoutingSource

DeviceMessages와 같이 라우팅 규칙을 적용할 원본입니다.

RoutingCosmosDBSqlApiProperties

cosmos DB sql 컨테이너 엔드포인트와 관련된 속성입니다.

Name 형식 Description
authenticationType

authenticationType

cosmos DB sql 컨테이너 엔드포인트에 대해 인증하는 데 사용되는 메서드
containerName

string

cosmos DB 데이터베이스에 있는 cosmos DB sql 컨테이너의 이름입니다.
databaseName

string

cosmos DB 계정의 cosmos DB 데이터베이스 이름입니다.
endpointUri

string

cosmos DB 계정의 URL입니다. 프로토콜 https:// 포함해야 합니다.
id

string

cosmos DB sql 컨테이너 엔드포인트의 ID
identity

ManagedIdentity

라우팅 cosmos DB 컨테이너 엔드포인트의 관리 ID 속성입니다.
name

string

이 엔드포인트를 식별하는 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자입니다. 예약된 이름은 이벤트, fileNotifications, $default. 엔드포인트 이름은 엔드포인트 유형에서 고유해야 합니다.
partitionKeyName

string

이 cosmos DB sql 컨테이너(있는 경우)와 연결된 파티션 키의 이름입니다. 선택적 매개 변수입니다.
partitionKeyTemplate

string

이 cosmos DB sql 컨테이너에 사용할 가상 파티션 키 값을 생성하기 위한 템플릿입니다. 템플릿에는 {iothub}, {deviceid}, {DD}, {MM}, {YYYY}와 같은 자리 표시자 중 하나 이상이 포함되어야 합니다. 한 자리 표시자는 한 번에 지정할 수 있지만 순서 및 자리 표시자가 아닌 구성 요소는 임의입니다. 이 매개 변수는 PartitionKeyName이 지정된 경우에만 필요합니다.
primaryKey

string

cosmos DB 계정의 기본 키입니다.
resourceGroup

string

cosmos DB 계정의 리소스 그룹 이름입니다.
secondaryKey

string

cosmos DB 계정의 보조 키입니다.
subscriptionId

string

cosmos DB 계정의 구독 식별자입니다.

RoutingEndpoints

IoT Hub가 라우팅 규칙에 따라 메시지를 라우팅하는 사용자 지정 엔드포인트와 관련된 속성입니다. 유료 허브의 모든 엔드포인트 유형에서 최대 10개의 사용자 지정 엔드포인트가 허용되며 무료 허브의 모든 엔드포인트 유형에서 1개의 사용자 지정 엔드포인트만 허용됩니다.

Name 형식 Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

라우팅 규칙에 따라 IoT Hub가 메시지를 라우팅하는 Cosmos DB 컨테이너 엔드포인트 목록입니다.
eventHubs

RoutingEventHubProperties[]

라우팅 규칙에 따라 IoT Hub가 메시지를 라우팅하는 Event Hubs 엔드포인트 목록입니다. 이 목록에는 기본 제공 Event Hubs 엔드포인트가 포함되어 있지 않습니다.
serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

라우팅 규칙에 따라 IoT Hub가 메시지를 라우팅하는 Service Bus 큐 엔드포인트 목록입니다.
serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

라우팅 규칙에 따라 IoT Hub가 메시지를 라우팅하는 Service Bus 토픽 엔드포인트 목록입니다.
storageContainers

RoutingStorageContainerProperties[]

라우팅 규칙에 따라 IoT Hub가 메시지를 라우팅하는 스토리지 컨테이너 엔드포인트 목록입니다.

RoutingEventHubProperties

이벤트 허브 엔드포인트와 관련된 속성입니다.

Name 형식 Description
authenticationType

authenticationType

이벤트 허브 엔드포인트에 대해 인증하는 데 사용되는 메서드
connectionString

string

이벤트 허브 엔드포인트의 연결 문자열.
endpointUri

string

이벤트 허브 엔드포인트의 URL입니다. 프로토콜 sb:// 포함해야 합니다.
entityPath

string

이벤트 허브 네임스페이스의 이벤트 허브 이름
id

string

이벤트 허브 엔드포인트의 ID
identity

ManagedIdentity

라우팅 이벤트 허브 엔드포인트의 관리 ID 속성입니다.
name

string

이 엔드포인트를 식별하는 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자입니다. 예약된 이름은 이벤트, fileNotifications, $default. 엔드포인트 이름은 엔드포인트 유형에서 고유해야 합니다.
resourceGroup

string

이벤트 허브 엔드포인트의 리소스 그룹 이름입니다.
subscriptionId

string

이벤트 허브 엔드포인트의 구독 식별자입니다.

RoutingProperties

IoT Hub의 라우팅 관련 속성입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging을 참조하세요.

Name 형식 Description
endpoints

RoutingEndpoints

IoT Hub가 라우팅 규칙에 따라 메시지를 라우팅하는 사용자 지정 엔드포인트와 관련된 속성입니다. 유료 허브의 모든 엔드포인트 유형에서 최대 10개의 사용자 지정 엔드포인트가 허용되며 무료 허브의 모든 엔드포인트 유형에서 1개의 사용자 지정 엔드포인트만 허용됩니다.
enrichments

EnrichmentProperties[]

IoT Hub가 기본 제공 및 사용자 지정 엔드포인트에 배달할 메시지에 적용되는 사용자 제공 보강 목록입니다. https://aka.ms/telemetryoneventgrid을 참조하세요.
fallbackRoute

FallbackRouteProperties

'경로' 섹션에 지정된 조건이 충족되지 않는 경우 대체 경로로 사용되는 경로의 속성입니다. 선택적 매개 변수입니다. 이 속성이 템플릿에 없는 경우 대체 경로는 기본적으로 사용하지 않도록 설정됩니다.
routes

RouteProperties[]

IoT Hub에서 메시지를 기본 제공 및 사용자 지정 엔드포인트로 라우팅하는 데 사용하는 사용자 제공 라우팅 규칙 목록입니다. 유료 허브에는 최대 100개의 라우팅 규칙이 허용되며 무료 허브에는 최대 5개의 라우팅 규칙이 허용됩니다.

RoutingServiceBusQueueEndpointProperties

Service Bus 큐 엔드포인트 유형과 관련된 속성입니다.

Name 형식 Description
authenticationType

authenticationType

Service Bus 큐 엔드포인트에 대해 인증하는 데 사용되는 메서드
connectionString

string

Service Bus 큐 엔드포인트의 연결 문자열.
endpointUri

string

Service Bus 큐 엔드포인트의 URL입니다. 프로토콜 sb:// 포함해야 합니다.
entityPath

string

Service Bus 네임스페이스의 큐 이름
id

string

Service Bus 큐 엔드포인트의 ID
identity

ManagedIdentity

라우팅 Service Bus 큐 엔드포인트의 관리 ID 속성입니다.
name

string

이 엔드포인트를 식별하는 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자입니다. 예약된 이름은 이벤트, fileNotifications, $default. 엔드포인트 이름은 엔드포인트 유형에서 고유해야 합니다. 이름은 실제 큐 이름과 동일할 필요가 없습니다.
resourceGroup

string

Service Bus 큐 엔드포인트의 리소스 그룹 이름입니다.
subscriptionId

string

Service Bus 큐 엔드포인트의 구독 식별자입니다.

RoutingServiceBusTopicEndpointProperties

Service Bus 토픽 엔드포인트 유형과 관련된 속성입니다.

Name 형식 Description
authenticationType

authenticationType

Service Bus 토픽 엔드포인트에 대해 인증하는 데 사용되는 메서드
connectionString

string

Service Bus 토픽 엔드포인트의 연결 문자열.
endpointUri

string

Service Bus 토픽 엔드포인트의 URL입니다. 프로토콜 sb:// 포함해야 합니다.
entityPath

string

Service Bus 토픽의 큐 이름
id

string

Service Bus 토픽 엔드포인트의 ID
identity

ManagedIdentity

라우팅 Service Bus 토픽 엔드포인트의 관리 ID 속성입니다.
name

string

이 엔드포인트를 식별하는 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자입니다. 예약된 이름은 이벤트, fileNotifications, $default. 엔드포인트 이름은 엔드포인트 유형에서 고유해야 합니다. 이름은 실제 토픽 이름과 동일할 필요가 없습니다.
resourceGroup

string

Service Bus 토픽 엔드포인트의 리소스 그룹 이름입니다.
subscriptionId

string

Service Bus 토픽 엔드포인트의 구독 식별자입니다.

RoutingSource

DeviceMessages와 같이 라우팅 규칙을 적용할 원본입니다.

Name 형식 Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

스토리지 컨테이너 엔드포인트와 관련된 속성입니다.

Name 형식 Description
authenticationType

authenticationType

스토리지 엔드포인트에 대해 인증하는 데 사용되는 메서드
batchFrequencyInSeconds

integer

Blob이 스토리지에 기록되는 시간 간격입니다. 값은 60초에서 720초 사이여야 합니다. 기본값은 300초입니다.
connectionString

string

스토리지 계정의 연결 문자열.
containerName

string

스토리지 계정의 스토리지 컨테이너 이름입니다.
encoding enum:
  • Avro
  • AvroDeflate
  • JSON

메시지를 Blob으로 직렬화하는 데 사용되는 인코딩입니다. 지원되는 값은 'avro', 'avrodeflate' 및 'JSON'입니다. 기본값은 'avro'입니다.
endpointUri

string

스토리지 엔드포인트의 URL입니다. 프로토콜 https:// 포함해야 합니다.
fileNameFormat

string

Blob의 파일 이름 형식입니다. 기본 형식은 {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}입니다. 모든 매개 변수는 필수이지만 순서를 변경할 수 있습니다.
id

string

스토리지 컨테이너 엔드포인트의 ID
identity

ManagedIdentity

라우팅 스토리지 엔드포인트의 관리 ID 속성입니다.
maxChunkSizeInBytes

integer

스토리지에 기록된 각 Blob의 최대 바이트 수입니다. 값은 10485760(10MB)와 524288000(500MB) 사이여야 합니다. 기본값은 314572800(300MB)입니다.
name

string

이 엔드포인트를 식별하는 이름입니다. 이름은 영숫자 문자, 마침표, 밑줄, 하이픈만 포함할 수 있으며 최대 길이는 64자입니다. 예약된 이름은 이벤트, fileNotifications, $default. 엔드포인트 이름은 엔드포인트 유형에서 고유해야 합니다.
resourceGroup

string

스토리지 계정의 리소스 그룹 이름입니다.
subscriptionId

string

스토리지 계정의 구독 식별자입니다.

SharedAccessSignatureAuthorizationRule

IoT Hub 공유 액세스 정책의 속성입니다.

Name 형식 Description
keyName

string

공유 액세스 정책의 이름입니다.
primaryKey

string

기본 키입니다.
rights

AccessRights

공유 액세스 정책에 할당된 권한입니다.
secondaryKey

string

보조 키입니다.

StorageEndpointProperties

파일 업로드를 위한 Azure Storage 엔드포인트의 속성입니다.

Name 형식 Description
authenticationType

AuthenticationType

스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.
connectionString

string

파일이 업로드되는 Azure Storage 계정의 연결 문자열.
containerName

string

파일을 업로드하는 루트 컨테이너의 이름입니다. 컨테이너는 존재하지 않아도 되지만 지정된 connectionString을 사용하여 만들 수 있어야 합니다.
identity

ManagedIdentity

파일 업로드를 위한 스토리지 엔드포인트의 관리 ID 속성입니다.
sasTtlAsIso8601

string

파일 업로드를 위해 IoT Hub 생성된 SAS URI가 유효한 기간입니다. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options를 참조하세요.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string

UTC(리소스 만들기)의 타임스탬프입니다.
createdBy

string

리소스를 만든 ID입니다.
createdByType

createdByType

리소스를 만든 ID 유형입니다.
lastModifiedAt

string

리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType

createdByType

리소스를 마지막으로 수정한 ID 유형입니다.

TagsResource

리소스에 대한 태그만 보유하는 컨테이너로, 사용자가 IoT Hub instance 태그를 업데이트할 수 있습니다.

Name 형식 Description
tags

object

리소스 태그