IotHubResource interface
Interfejs reprezentujący element IotHubResource.
Metody
begin |
Utwórz lub zaktualizuj metadane centrum IoT. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych i metadanych zabezpieczeń centrum IoT, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania centrum IoT. Jeśli w formacie JSON brakuje niektórych właściwości, aktualizacja IoT Hub może spowodować powrót tych wartości do wartości domyślnych, co może prowadzić do nieoczekiwanego zachowania. |
begin |
Utwórz lub zaktualizuj metadane centrum IoT. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych i metadanych zabezpieczeń centrum IoT, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania centrum IoT. Jeśli w formacie JSON brakuje niektórych właściwości, aktualizacja IoT Hub może spowodować powrót tych wartości do wartości domyślnych, co może prowadzić do nieoczekiwanego zachowania. |
begin |
Usuń centrum IoT Hub. |
begin |
Usuń centrum IoT Hub. |
begin |
Aktualizowanie istniejących tagów IoT Hub. aby zaktualizować inne pola, użyj metody CreateOrUpdate |
begin |
Aktualizowanie istniejących tagów IoT Hub. aby zaktualizować inne pola, użyj metody CreateOrUpdate |
check |
Sprawdź, czy nazwa centrum IoT jest dostępna. |
create |
Dodaj grupę odbiorców do punktu końcowego zgodnego z centrum zdarzeń w centrum IoT. |
delete |
Usuń grupę odbiorców z punktu końcowego zgodnego z centrum zdarzeń w centrum IoT Hub. |
export |
Eksportuje wszystkie tożsamości urządzeń w rejestrze tożsamości usługi IoT Hub do kontenera obiektów blob usługi Azure Storage. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
get(string, string, Iot |
Pobierz metadane związane z zabezpieczeniami centrum IoT Hub. |
get |
Pobierz grupę odbiorców z punktu końcowego zgodnego z centrum zdarzeń z urządzenia do chmury dla centrum IoT Hub. |
get |
Uzyskaj szczegółowe informacje o zadaniu z centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
get |
Pobierz zasady dostępu współdzielonego według nazwy z centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
get |
Pobierz statystyki z centrum IoT Hub. |
import |
Importowanie, aktualizowanie lub usuwanie tożsamości urządzeń w rejestrze tożsamości usługi IoT Hub z obiektu blob. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
list |
Pobierz wszystkie centra IoT w grupie zasobów. |
list |
Pobierz wszystkie centra IoT w ramach subskrypcji. |
list |
Uzyskaj kondycję punktów końcowych routingu. |
list |
Pobierz listę grup odbiorców w punkcie końcowym zgodnym z centrum zdarzeń z urządzenia do chmury w centrum IoT. |
list |
Pobierz listę wszystkich zadań w centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
list |
Pobierz metadane zabezpieczeń dla centrum IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
list |
Pobierz metryki przydziału dla centrum IoT Hub. |
list |
Pobierz listę prawidłowych jednostek SKU dla centrum IoT. |
test |
Przetestuj wszystkie trasy skonfigurowane w tym centrum IoT Hub |
test |
Testowanie nowej trasy dla tego centrum IoT Hub |
Szczegóły metody
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Utwórz lub zaktualizuj metadane centrum IoT. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych i metadanych zabezpieczeń centrum IoT, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania centrum IoT. Jeśli w formacie JSON brakuje niektórych właściwości, aktualizacja IoT Hub może spowodować powrót tych wartości do wartości domyślnych, co może prowadzić do nieoczekiwanego zachowania.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- iotHubDescription
- IotHubDescription
Metadane i metadane zabezpieczeń centrum IoT Hub.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Utwórz lub zaktualizuj metadane centrum IoT. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych i metadanych zabezpieczeń centrum IoT, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania centrum IoT. Jeśli w formacie JSON brakuje niektórych właściwości, aktualizacja IoT Hub może spowodować powrót tych wartości do wartości domyślnych, co może prowadzić do nieoczekiwanego zachowania.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- iotHubDescription
- IotHubDescription
Metadane i metadane zabezpieczeń centrum IoT Hub.
Parametry opcji.
Zwraca
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Usuń centrum IoT Hub.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Usuń centrum IoT Hub.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aktualizowanie istniejących tagów IoT Hub. aby zaktualizować inne pola, użyj metody CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- resourceName
-
string
Nazwa centrum ioT do zaktualizowania.
- iotHubTags
- TagsResource
Zaktualizowano informacje o tagach, aby ustawić je w wystąpieniu centrum iot.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aktualizowanie istniejących tagów IoT Hub. aby zaktualizować inne pola, użyj metody CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- resourceName
-
string
Nazwa centrum ioT do zaktualizowania.
- iotHubTags
- TagsResource
Zaktualizowano informacje o tagach, aby ustawić je w wystąpieniu centrum iot.
Parametry opcji.
Zwraca
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Sprawdź, czy nazwa centrum IoT jest dostępna.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parametry
- operationInputs
- OperationInputs
Ustaw parametr name w strukturze OperationInputs na nazwę centrum IoT, aby sprawdzić.
Parametry opcji.
Zwraca
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Dodaj grupę odbiorców do punktu końcowego zgodnego z centrum zdarzeń w centrum IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- eventHubEndpointName
-
string
Nazwa punktu końcowego zgodnego z centrum zdarzeń w centrum IoT.
- name
-
string
Nazwa grupy odbiorców do dodania.
Parametry opcji.
Zwraca
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Usuń grupę odbiorców z punktu końcowego zgodnego z centrum zdarzeń w centrum IoT Hub.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- eventHubEndpointName
-
string
Nazwa punktu końcowego zgodnego z centrum zdarzeń w centrum IoT.
- name
-
string
Nazwa grupy odbiorców do usunięcia.
Parametry opcji.
Zwraca
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Eksportuje wszystkie tożsamości urządzeń w rejestrze tożsamości usługi IoT Hub do kontenera obiektów blob usługi Azure Storage. Aby uzyskać więcej informacji, zobacz 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>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- exportDevicesParameters
- ExportDevicesRequest
Parametry określające operację eksportowania urządzeń.
Parametry opcji.
Zwraca
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Pobierz metadane związane z zabezpieczeniami centrum IoT Hub.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- options
- IotHubResourceGetOptionalParams
Parametry opcji.
Zwraca
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Pobierz grupę odbiorców z punktu końcowego zgodnego z centrum zdarzeń z urządzenia do chmury dla centrum IoT Hub.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- eventHubEndpointName
-
string
Nazwa punktu końcowego zgodnego z centrum zdarzeń w centrum IoT.
- name
-
string
Nazwa grupy odbiorców do pobrania.
Parametry opcji.
Zwraca
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Uzyskaj szczegółowe informacje o zadaniu z centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- jobId
-
string
Identyfikator zadania.
Parametry opcji.
Zwraca
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Pobierz zasady dostępu współdzielonego według nazwy z centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- keyName
-
string
Nazwa zasad dostępu współdzielonego.
Parametry opcji.
Zwraca
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Pobierz statystyki z centrum IoT Hub.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importowanie, aktualizowanie lub usuwanie tożsamości urządzeń w rejestrze tożsamości usługi IoT Hub z obiektu blob. Aby uzyskać więcej informacji, zobacz 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>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- importDevicesParameters
- ImportDevicesRequest
Parametry określające operację importowania urządzeń.
Parametry opcji.
Zwraca
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Pobierz wszystkie centra IoT w grupie zasobów.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
Parametry opcji.
Zwraca
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Pobierz wszystkie centra IoT w ramach subskrypcji.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametry
Parametry opcji.
Zwraca
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Uzyskaj kondycję punktów końcowych routingu.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parametry
- resourceGroupName
-
string
- iotHubName
-
string
Parametry opcji.
Zwraca
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Pobierz listę grup odbiorców w punkcie końcowym zgodnym z centrum zdarzeń z urządzenia do chmury w centrum IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
- eventHubEndpointName
-
string
Nazwa punktu końcowego zgodnego z centrum zdarzeń.
Parametry opcji.
Zwraca
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Pobierz listę wszystkich zadań w centrum IoT. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Pobierz metadane zabezpieczeń dla centrum IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Pobierz metryki przydziału dla centrum IoT Hub.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Pobierz listę prawidłowych jednostek SKU dla centrum IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej centrum IoT.
- resourceName
-
string
Nazwa centrum IoT.
Parametry opcji.
Zwraca
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Przetestuj wszystkie trasy skonfigurowane w tym centrum IoT Hub
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parametry
- iotHubName
-
string
Testowanie usługi IotHub
- resourceGroupName
-
string
grupa zasobów, do której należy usługa Iot Hub
- input
- TestAllRoutesInput
Dane wejściowe do testowania wszystkich tras
Parametry opcji.
Zwraca
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Testowanie nowej trasy dla tego centrum IoT Hub
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parametry
- iotHubName
-
string
Testowanie usługi IotHub
- resourceGroupName
-
string
grupa zasobów, do której należy usługa Iot Hub
- input
- TestRouteInput
Trasa, która musi zostać przetestowana
Parametry opcji.
Zwraca
Promise<TestRouteResult>