IotHubResource interface
IotHubResource'ı temsil eden arabirim.
Yöntemler
Yöntem Ayrıntıları
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT hub'ının meta verilerini oluşturun veya güncelleştirin. Bir özelliği değiştirmek için kullanılan normal düzen, IoT hub meta verilerini ve güvenlik meta verilerini almak ve ardından bunları yeni bir gövdedeki değiştirilmiş değerlerle birleştirerek IoT hub'ını güncelleştirmektir. JSON'da belirli özellikler eksikse, IoT Hub'ın güncelleştirilmesi bu değerlerin varsayılan değere geri döndürülmesine neden olabilir ve bu da beklenmeyen davranışlara yol açabilir.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- iotHubDescription
- IotHubDescription
IoT hub meta verileri ve güvenlik meta verileri.
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
IoT hub'ının meta verilerini oluşturun veya güncelleştirin. Bir özelliği değiştirmek için kullanılan normal düzen, IoT hub meta verilerini ve güvenlik meta verilerini almak ve ardından bunları yeni bir gövdedeki değiştirilmiş değerlerle birleştirerek IoT hub'ını güncelleştirmektir. JSON'da belirli özellikler eksikse, IoT Hub'ın güncelleştirilmesi bu değerlerin varsayılan değere geri döndürülmesine neden olabilir ve bu da beklenmeyen davranışlara yol açabilir.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- iotHubDescription
- IotHubDescription
IoT hub meta verileri ve güvenlik meta verileri.
Seçenekler parametreleri.
Döndürülenler
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
IoT hub'larını silme.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
IoT hub'larını silme.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Mevcut IoT Hub etiketlerini güncelleştirin. diğer alanları güncelleştirmek için CreateOrUpdate yöntemini kullanın
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametreler
- resourceGroupName
-
string
Kaynak grubu tanımlayıcısı.
- resourceName
-
string
Güncelleştirilecek iot hub'ının adı.
- iotHubTags
- TagsResource
Etiket bilgileri iot hub örneğine ayarlı olarak güncelleştirildi.
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Mevcut IoT Hub etiketlerini güncelleştirin. diğer alanları güncelleştirmek için CreateOrUpdate yöntemini kullanın
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Parametreler
- resourceGroupName
-
string
Kaynak grubu tanımlayıcısı.
- resourceName
-
string
Güncelleştirilecek iot hub'ının adı.
- iotHubTags
- TagsResource
Etiket bilgileri iot hub örneğine ayarlı olarak güncelleştirildi.
Seçenekler parametreleri.
Döndürülenler
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Bir IoT hub adının kullanılabilir olup olmadığını denetleyin.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parametreler
- operationInputs
- OperationInputs
OperationInputs yapısındaki name parametresini denetlenecek IoT hub'ının adı olarak ayarlayın.
Seçenekler parametreleri.
Döndürülenler
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
IoT hub'ında Event Hub uyumlu bir uç noktaya bir tüketici grubu ekleyin.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- eventHubEndpointName
-
string
IoT hub'ında Event Hub ile uyumlu uç noktanın adı.
- name
-
string
Eklenecek tüketici grubunun adı.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Eklenecek tüketici grubu.
Seçenekler parametreleri.
Döndürülenler
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
IoT hub'ında Event Hub uyumlu bir uç noktadan bir tüketici grubunu silin.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- eventHubEndpointName
-
string
IoT hub'ında Event Hub ile uyumlu uç noktanın adı.
- name
-
string
Silinecek tüketici grubunun adı.
Seçenekler parametreleri.
Döndürülenler
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
IoT hub kimlik kayıt defterindeki tüm cihaz kimliklerini bir Azure Depolama blob kapsayıcısına aktarır. Daha fazla bilgi için bkz. 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>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- exportDevicesParameters
- ExportDevicesRequest
Cihazları dışarı aktarma işlemini belirten parametreler.
Seçenekler parametreleri.
Döndürülenler
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
IoT hub'ının güvenlikle ilgili olmayan meta verilerini alın.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- options
- IotHubResourceGetOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
IoT hub'ı için Event Hub uyumlu cihazdan buluta uç noktasından bir tüketici grubu alın.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- eventHubEndpointName
-
string
IoT hub'ında Event Hub ile uyumlu uç noktanın adı.
- name
-
string
Alınacak tüketici grubunun adı.
Seçenekler parametreleri.
Döndürülenler
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
IoT hub'ından bir işin ayrıntılarını alın. Daha fazla bilgi için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- jobId
-
string
İş tanımlayıcısı.
Seçenekler parametreleri.
Döndürülenler
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
IoT hub'ından ada göre paylaşılan erişim ilkesi alın. Daha fazla bilgi için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- keyName
-
string
Paylaşılan erişim ilkesinin adı.
Seçenekler parametreleri.
Döndürülenler
getStats(string, string, IotHubResourceGetStatsOptionalParams)
IoT hub'ından istatistikleri alın.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
IoT hub kimlik kayıt defterindeki cihaz kimliklerini bir blobdan içeri aktarın, güncelleştirin veya silin. Daha fazla bilgi için bkz. 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>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- importDevicesParameters
- ImportDevicesRequest
cihazları içeri aktarma işlemini belirten parametreler.
Seçenekler parametreleri.
Döndürülenler
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Bir kaynak grubundaki tüm IoT hub'larını alın.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
Seçenekler parametreleri.
Döndürülenler
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Bir abonelikteki tüm IoT hub'larını alın.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametreler
Seçenekler parametreleri.
Döndürülenler
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Yönlendirme uç noktaları için sistem durumunu alın.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parametreler
- resourceGroupName
-
string
- iotHubName
-
string
Seçenekler parametreleri.
Döndürülenler
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
IoT hub'ında Event Hub uyumlu cihazdan buluta uç noktasındaki tüketici gruplarının listesini alın.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
- eventHubEndpointName
-
string
Event Hub ile uyumlu uç noktanın adı.
Seçenekler parametreleri.
Döndürülenler
listJobs(string, string, IotHubResourceListJobsOptionalParams)
IoT hub'ında tüm işlerin listesini alın. Daha fazla bilgi için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
listKeys(string, string, IotHubResourceListKeysOptionalParams)
IoT hub'ına yönelik güvenlik meta verilerini alın. Daha fazla bilgi için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
IoT hub'ı için kota ölçümlerini alın.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
IoT hub'ı için geçerli SKU'ların listesini alın.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parametreler
- resourceGroupName
-
string
IoT hub'ını içeren kaynak grubunun adı.
- resourceName
-
string
IoT hub'ının adı.
Seçenekler parametreleri.
Döndürülenler
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Bu Iot Hub'da yapılandırılan tüm yolları test edin
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parametreler
- iotHubName
-
string
IotHub test edilecek
- resourceGroupName
-
string
Iot Hub'ın ait olduğu kaynak grubu
- input
- TestAllRoutesInput
Tüm yolları test etme girişi
Seçenekler parametreleri.
Döndürülenler
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Bu Iot Hub için yeni yolu test edin
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parametreler
- iotHubName
-
string
IotHub test edilecek
- resourceGroupName
-
string
Iot Hub'ın ait olduğu kaynak grubu
- input
- TestRouteInput
Test edilmesi gereken yol
Seçenekler parametreleri.
Döndürülenler
Promise<TestRouteResult>