IotHubResource interface
IotHubResource를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT 허브의 메타데이터를 만들거나 업데이트합니다. 속성을 수정하는 일반적인 패턴은 IoT Hub 메타데이터 및 보안 메타데이터를 검색한 다음 새 본문의 수정된 값과 결합하여 IoT Hub를 업데이트하는 것입니다. JSON에 특정 속성이 누락된 경우 IoT Hub를 업데이트하면 이러한 값이 기본값으로 대체되어 예기치 않은 동작이 발생할 수 있습니다.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- iotHubDescription
- IotHubDescription
IoT Hub 메타데이터 및 보안 메타데이터입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT 허브의 메타데이터를 만들거나 업데이트합니다. 속성을 수정하는 일반적인 패턴은 IoT Hub 메타데이터 및 보안 메타데이터를 검색한 다음 새 본문의 수정된 값과 결합하여 IoT Hub를 업데이트하는 것입니다. JSON에 특정 속성이 누락된 경우 IoT Hub를 업데이트하면 이러한 값이 기본값으로 대체되어 예기치 않은 동작이 발생할 수 있습니다.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- iotHubDescription
- IotHubDescription
IoT Hub 메타데이터 및 보안 메타데이터입니다.
옵션 매개 변수입니다.
반환
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
IoT Hub를 삭제합니다.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
IoT Hub를 삭제합니다.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
기존 IoT Hub 태그를 업데이트합니다. CreateOrUpdate 메서드를 사용하여 다른 필드를 업데이트하려면
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>매개 변수
- resourceGroupName
-
string
리소스 그룹 식별자입니다.
- resourceName
-
string
업데이트할 IoT 허브의 이름입니다.
- iotHubTags
- TagsResource
IoT 허브 인스턴스로 설정하도록 태그 정보를 업데이트했습니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
기존 IoT Hub 태그를 업데이트합니다. CreateOrUpdate 메서드를 사용하여 다른 필드를 업데이트하려면
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>매개 변수
- resourceGroupName
-
string
리소스 그룹 식별자입니다.
- resourceName
-
string
업데이트할 IoT 허브의 이름입니다.
- iotHubTags
- TagsResource
IoT 허브 인스턴스로 설정하도록 태그 정보를 업데이트했습니다.
옵션 매개 변수입니다.
반환
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
IoT Hub 이름을 사용할 수 있는지 확인합니다.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>매개 변수
- operationInputs
- OperationInputs
OperationInputs 구조의 이름 매개 변수를 확인할 IoT Hub의 이름으로 설정합니다.
옵션 매개 변수입니다.
반환
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
IoT Hub의 Event Hub 호환 엔드포인트에 소비자 그룹을 추가합니다.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- eventHubEndpointName
-
string
IoT Hub의 Event Hub 호환 엔드포인트 이름입니다.
- name
-
string
추가할 소비자 그룹의 이름입니다.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
추가할 소비자 그룹입니다.
옵션 매개 변수입니다.
반환
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
IoT Hub의 Event Hub 호환 엔드포인트에서 소비자 그룹을 삭제합니다.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- eventHubEndpointName
-
string
IoT Hub의 Event Hub 호환 엔드포인트 이름입니다.
- name
-
string
삭제할 소비자 그룹의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
IoT Hub ID 레지스트리의 모든 디바이스 ID를 Azure Storage Blob 컨테이너로 내보냅니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- exportDevicesParameters
- ExportDevicesRequest
디바이스 내보내기 작업을 지정하는 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
IoT Hub의 비보안 관련 메타데이터를 가져옵니다.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- options
- IotHubResourceGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
IoT Hub에 대한 Event Hub 호환 디바이스-클라우드 엔드포인트에서 소비자 그룹을 가져옵니다.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- eventHubEndpointName
-
string
IoT Hub의 Event Hub 호환 엔드포인트 이름입니다.
- name
-
string
검색할 소비자 그룹의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
IoT Hub에서 작업의 세부 정보를 가져옵니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- jobId
-
string
작업 식별자입니다.
옵션 매개 변수입니다.
반환
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
IoT Hub에서 이름으로 공유 액세스 정책을 가져옵니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- keyName
-
string
공유 액세스 정책의 이름입니다.
옵션 매개 변수입니다.
반환
getStats(string, string, IotHubResourceGetStatsOptionalParams)
IoT Hub에서 통계를 가져옵니다.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Blob에서 IoT Hub ID 레지스트리의 디바이스 ID를 가져오거나 업데이트하거나 삭제합니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- importDevicesParameters
- ImportDevicesRequest
디바이스 가져오기 작업을 지정하는 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
리소스 그룹의 모든 IoT Hub를 가져옵니다.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
옵션 매개 변수입니다.
반환
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
구독의 모든 IoT Hub를 가져옵니다.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>매개 변수
옵션 매개 변수입니다.
반환
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
라우팅 엔드포인트에 대한 상태를 가져옵니다.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>매개 변수
- resourceGroupName
-
string
- iotHubName
-
string
옵션 매개 변수입니다.
반환
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
IoT Hub의 Event Hub 호환 디바이스-클라우드 엔드포인트에서 소비자 그룹 목록을 가져옵니다.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
- eventHubEndpointName
-
string
Event Hub 호환 엔드포인트의 이름입니다.
옵션 매개 변수입니다.
반환
listJobs(string, string, IotHubResourceListJobsOptionalParams)
IoT Hub의 모든 작업 목록을 가져옵니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
listKeys(string, string, IotHubResourceListKeysOptionalParams)
IoT Hub에 대한 보안 메타데이터를 가져옵니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
IoT Hub에 대한 할당량 메트릭을 가져옵니다.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
IoT Hub에 대한 유효한 SKU 목록을 가져옵니다.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>매개 변수
- resourceGroupName
-
string
IoT Hub를 포함하는 리소스 그룹의 이름입니다.
- resourceName
-
string
IoT Hub의 이름입니다.
옵션 매개 변수입니다.
반환
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
이 IoT Hub에 구성된 모든 경로 테스트
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>매개 변수
- iotHubName
-
string
테스트할 IotHub
- resourceGroupName
-
string
IoT Hub가 속한 리소스 그룹
- input
- TestAllRoutesInput
모든 경로를 테스트하기 위한 입력
옵션 매개 변수입니다.
반환
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
이 IoT Hub에 대한 새 경로 테스트
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>매개 변수
- iotHubName
-
string
테스트할 IotHub
- resourceGroupName
-
string
IoT Hub가 속한 리소스 그룹
- input
- TestRouteInput
테스트해야 하는 경로
옵션 매개 변수입니다.
반환
Promise<TestRouteResult>