IotHubResource interface

套件:

@azure/arm-iothub

代表 IotHubResource 的介面。

方法

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)	建立或更新IoT中樞的元數據。 修改屬性的一般模式是擷取IoT中樞元數據和安全性元數據，然後將它們與新主體中已修改的值結合，以更新IoT中樞。 如果 JSON 中遺漏某些屬性，更新 IoT 中樞可能會導致這些值回復為預設值，這可能會導致非預期的行為。
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)	建立或更新IoT中樞的元數據。 修改屬性的一般模式是擷取IoT中樞元數據和安全性元數據，然後將它們與新主體中已修改的值結合，以更新IoT中樞。 如果 JSON 中遺漏某些屬性，更新 IoT 中樞可能會導致這些值回復為預設值，這可能會導致非預期的行為。
beginDelete(string, string, IotHubResourceDeleteOptionalParams)	刪除 IoT 中樞。
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)	刪除 IoT 中樞。
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)	更新現有的IoT中樞標籤。 若要更新其他欄位，請使用 CreateOrUpdate 方法
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)	更新現有的IoT中樞標籤。 若要更新其他欄位，請使用 CreateOrUpdate 方法
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)	檢查 IoT 中樞名稱是否可用。
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)	將取用者群組新增至IoT中樞與事件中樞相容的端點。
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)	從 IoT 中樞的事件中樞相容端點刪除取用者群組。
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)	將 IoT 中樞身分識別登錄中的所有裝置身分識別匯出至 Azure 記憶體 Blob 容器。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。
get(string, string, IotHubResourceGetOptionalParams)	取得IoT中樞的非安全性相關元數據。
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)	從 IoT 中樞的事件中樞相容裝置到雲端端點取得取用者群組。
getJob(string, string, string, IotHubResourceGetJobOptionalParams)	從IoT中樞取得作業的詳細數據。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)	依名稱從IoT中樞取得共用存取原則。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。
getStats(string, string, IotHubResourceGetStatsOptionalParams)	從 IoT 中樞取得統計數據。
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)	從 Blob 匯入、更新或刪除 IoT 中樞身分識別登錄中的裝置身分識別。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)	取得資源群組中的所有IoT中樞。
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)	取得訂用帳戶中的所有IoT中樞。
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)	取得路由端點的健康情況。
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)	取得IoT中樞中事件中樞相容裝置到雲端端點中的取用者群組清單。
listJobs(string, string, IotHubResourceListJobsOptionalParams)	取得IoT中樞內所有作業的清單。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。
listKeys(string, string, IotHubResourceListKeysOptionalParams)	取得IoT中樞的安全性元數據。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)	取得IoT中樞的配額計量。
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)	取得IoT中樞的有效SKU清單。
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)	測試此 IoT 中樞中設定的所有路由
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)	測試此 IoT 中樞的新路由

方法詳細資料

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

建立或更新IoT中樞的元數據。 修改屬性的一般模式是擷取IoT中樞元數據和安全性元數據，然後將它們與新主體中已修改的值結合，以更新IoT中樞。 如果 JSON 中遺漏某些屬性，更新 IoT 中樞可能會導致這些值回復為預設值，這可能會導致非預期的行為。

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

iotHubDescription

IotHubDescription

IoT 中樞元數據和安全性元數據。

options

IotHubResourceCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

建立或更新IoT中樞的元數據。 修改屬性的一般模式是擷取IoT中樞元數據和安全性元數據，然後將它們與新主體中已修改的值結合，以更新IoT中樞。 如果 JSON 中遺漏某些屬性，更新 IoT 中樞可能會導致這些值回復為預設值，這可能會導致非預期的行為。

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

iotHubDescription

IotHubDescription

IoT 中樞元數據和安全性元數據。

options

IotHubResourceCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<IotHubDescription>

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

刪除 IoT 中樞。

function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceDeleteOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

刪除 IoT 中樞。

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceDeleteOptionalParams

選項參數。

傳回

Promise<IotHubDescription>

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

更新現有的IoT中樞標籤。 若要更新其他欄位，請使用 CreateOrUpdate 方法

function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

參數

resourceGroupName

string

資源群組標識碼。

resourceName

string

要更新的 iot 中樞名稱。

iotHubTags

TagsResource

已更新要設定為 iot 中樞實例的標記資訊。

options

IotHubResourceUpdateOptionalParams

選項參數。

傳回

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

更新現有的IoT中樞標籤。 若要更新其他欄位，請使用 CreateOrUpdate 方法

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>

參數

resourceGroupName

string

資源群組標識碼。

resourceName

string

要更新的 iot 中樞名稱。

iotHubTags

TagsResource

已更新要設定為 iot 中樞實例的標記資訊。

options

IotHubResourceUpdateOptionalParams

選項參數。

傳回

Promise<IotHubDescription>

checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)

檢查 IoT 中樞名稱是否可用。

function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>

參數

operationInputs

OperationInputs

將 OperationInputs 結構中的 name 參數設定為要檢查的 IoT 中樞名稱。

options

IotHubResourceCheckNameAvailabilityOptionalParams

選項參數。

傳回

Promise<IotHubNameAvailabilityInfo>

createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)

將取用者群組新增至IoT中樞與事件中樞相容的端點。

function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

eventHubEndpointName

string

IoT 中樞中事件中樞相容端點的名稱。

name

string

要加入的取用者群組名稱。

consumerGroupBody

EventHubConsumerGroupBodyDescription

要新增的取用者群組。

options

IotHubResourceCreateEventHubConsumerGroupOptionalParams

選項參數。

傳回

Promise<EventHubConsumerGroupInfo>

deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)

從 IoT 中樞的事件中樞相容端點刪除取用者群組。

function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

eventHubEndpointName

string

IoT 中樞中事件中樞相容端點的名稱。

name

string

要刪除的取用者群組名稱。

options

IotHubResourceDeleteEventHubConsumerGroupOptionalParams

選項參數。

傳回

Promise<void>

exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)

將 IoT 中樞身分識別登錄中的所有裝置身分識別匯出至 Azure 記憶體 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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

exportDevicesParameters

ExportDevicesRequest

指定匯出裝置作業的參數。

options

IotHubResourceExportDevicesOptionalParams

選項參數。

傳回

Promise<JobResponse>

get(string, string, IotHubResourceGetOptionalParams)

取得IoT中樞的非安全性相關元數據。

function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceGetOptionalParams

選項參數。

傳回

Promise<IotHubDescription>

getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)

從 IoT 中樞的事件中樞相容裝置到雲端端點取得取用者群組。

function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

eventHubEndpointName

string

IoT 中樞中事件中樞相容端點的名稱。

name

string

要擷取的取用者群組名稱。

options

IotHubResourceGetEventHubConsumerGroupOptionalParams

選項參數。

傳回

Promise<EventHubConsumerGroupInfo>

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

從IoT中樞取得作業的詳細數據。 如需詳細資訊，請參閱：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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

jobId

string

作業標識碼。

options

IotHubResourceGetJobOptionalParams

選項參數。

傳回

Promise<JobResponse>

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

依名稱從IoT中樞取得共用存取原則。 如需詳細資訊，請參閱：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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

keyName

string

共用存取原則的名稱。

options

IotHubResourceGetKeysForKeyNameOptionalParams

選項參數。

傳回

Promise<SharedAccessSignatureAuthorizationRule>

getStats(string, string, IotHubResourceGetStatsOptionalParams)

從 IoT 中樞取得統計數據。

function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceGetStatsOptionalParams

選項參數。

傳回

Promise<RegistryStatistics>

importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)

從 Blob 匯入、更新或刪除 IoT 中樞身分識別登錄中的裝置身分識別。 如需詳細資訊，請參閱：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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

importDevicesParameters

ImportDevicesRequest

指定匯入裝置作業的參數。

options

IotHubResourceImportDevicesOptionalParams

選項參數。

傳回

Promise<JobResponse>

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

取得資源群組中的所有IoT中樞。

function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

options

IotHubResourceListByResourceGroupOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

取得訂用帳戶中的所有IoT中樞。

function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

參數

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

options

IotHubResourceGetEndpointHealthOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

取得IoT中樞中事件中樞相容裝置到雲端端點中的取用者群組清單。

function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

eventHubEndpointName

string

事件中樞相容端點的名稱。

options

IotHubResourceListEventHubConsumerGroupsOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>

listJobs(string, string, IotHubResourceListJobsOptionalParams)

取得IoT中樞內所有作業的清單。 如需詳細資訊，請參閱：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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceListJobsOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

listKeys(string, string, IotHubResourceListKeysOptionalParams)

取得IoT中樞的安全性元數據。 如需詳細資訊，請參閱：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中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceListKeysOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>

listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)

取得IoT中樞的配額計量。

function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceGetQuotaMetricsOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>

listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)

取得IoT中樞的有效SKU清單。

function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>

參數

resourceGroupName

string

包含IoT中樞的資源群組名稱。

resourceName

string

IoT 中樞的名稱。

options

IotHubResourceGetValidSkusOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>

testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)

測試此 IoT 中樞中設定的所有路由

function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>

參數

iotHubName

string

要測試的 IotHub

resourceGroupName

string

IoT 中樞所屬的資源群組

input

TestAllRoutesInput

測試所有路由的輸入

options

IotHubResourceTestAllRoutesOptionalParams

選項參數。

傳回

Promise<TestAllRoutesResult>

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

測試此 IoT 中樞的新路由

function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>

參數

iotHubName

string

要測試的 IotHub

resourceGroupName

string

IoT 中樞所屬的資源群組

input

TestRouteInput

需要測試的路由

options

IotHubResourceTestRouteOptionalParams

選項參數。

傳回

Promise<TestRouteResult>