IotHubResource interface
Interface die een IotHubResource vertegenwoordigt.
Methoden
begin |
De metagegevens van een IoT-hub maken of bijwerken. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de IoT-hub op te halen en deze vervolgens te combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de IoT-hub bij te werken. Als bepaalde eigenschappen ontbreken in de JSON, kan het bijwerken van IoT Hub ervoor zorgen dat deze waarden terugvallen naar de standaardwaarde, wat kan leiden tot onverwacht gedrag. |
begin |
De metagegevens van een IoT-hub maken of bijwerken. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de IoT-hub op te halen en deze vervolgens te combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de IoT-hub bij te werken. Als bepaalde eigenschappen ontbreken in de JSON, kan het bijwerken van IoT Hub ervoor zorgen dat deze waarden terugvallen naar de standaardwaarde, wat kan leiden tot onverwacht gedrag. |
begin |
Een IoT-hub verwijderen. |
begin |
Een IoT-hub verwijderen. |
begin |
Een bestaande IoT Hub tags bijwerken. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate |
begin |
Een bestaande IoT Hub tags bijwerken. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate |
check |
Controleer of de naam van een IoT-hub beschikbaar is. |
create |
Voeg een consumentengroep toe aan een Event Hub-compatibel eindpunt in een IoT-hub. |
delete |
Een consumentengroep verwijderen uit een Event Hub-compatibel eindpunt in een IoT-hub. |
export |
Hiermee exporteert u alle apparaatidentiteiten in het IoT Hub-identiteitsregister naar een Azure Storage-blobcontainer. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie. |
get(string, string, Iot |
Haal de niet-beveiligingsgerelateerde metagegevens van een IoT-hub op. |
get |
Haal een consumentengroep op uit het event hub-compatibele apparaat-naar-cloud-eindpunt voor een IoT-hub. |
get |
Haal de details van een taak op uit een IoT-hub. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry voor meer informatie. |
get |
Een beleid voor gedeelde toegang op naam ophalen uit een IoT-hub. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security voor meer informatie. |
get |
Haal de statistieken op uit een IoT-hub. |
import |
Apparaat-id's in het IoT Hub-identiteitsregister importeren, bijwerken of verwijderen uit een blob. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie. |
list |
Alle IoT-hubs in een resourcegroep ophalen. |
list |
Haal alle IoT-hubs in een abonnement op. |
list |
Haal de status op voor routeringseindpunten. |
list |
Haal een lijst op van de consumentengroepen in het event hub-compatibele apparaat-naar-cloud-eindpunt in een IoT-hub. |
list |
Een lijst met alle taken in een IoT-hub ophalen. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry voor meer informatie. |
list |
Haal de beveiligingsmetagegevens voor een IoT-hub op. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security voor meer informatie. |
list |
Haal de metrische quotumgegevens voor een IoT-hub op. |
list |
Haal de lijst met geldige SKU's voor een IoT-hub op. |
test |
Alle routes testen die zijn geconfigureerd in deze IoT Hub |
test |
De nieuwe route voor deze IoT-hub testen |
Methodedetails
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
De metagegevens van een IoT-hub maken of bijwerken. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de IoT-hub op te halen en deze vervolgens te combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de IoT-hub bij te werken. Als bepaalde eigenschappen ontbreken in de JSON, kan het bijwerken van IoT Hub ervoor zorgen dat deze waarden terugvallen naar de standaardwaarde, wat kan leiden tot onverwacht gedrag.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- iotHubDescription
- IotHubDescription
De metagegevens en beveiligingsmetagegevens van de IoT-hub.
De optiesparameters.
Retouren
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
De metagegevens van een IoT-hub maken of bijwerken. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de IoT-hub op te halen en deze vervolgens te combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de IoT-hub bij te werken. Als bepaalde eigenschappen ontbreken in de JSON, kan het bijwerken van IoT Hub ervoor zorgen dat deze waarden terugvallen naar de standaardwaarde, wat kan leiden tot onverwacht gedrag.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- iotHubDescription
- IotHubDescription
De metagegevens en beveiligingsmetagegevens van de IoT-hub.
De optiesparameters.
Retouren
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Een IoT-hub verwijderen.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Een IoT-hub verwijderen.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Een bestaande IoT Hub tags bijwerken. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>
Parameters
- resourceGroupName
-
string
Resourcegroep-id.
- resourceName
-
string
Naam van ioT-hub die moet worden bijgewerkt.
- iotHubTags
- TagsResource
Bijgewerkte taggegevens die moeten worden ingesteld in het ioT-hub-exemplaar.
De optiesparameters.
Retouren
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Een bestaande IoT Hub tags bijwerken. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Parameters
- resourceGroupName
-
string
Resourcegroep-id.
- resourceName
-
string
Naam van ioT-hub die moet worden bijgewerkt.
- iotHubTags
- TagsResource
Bijgewerkte taggegevens die moeten worden ingesteld in het ioT-hub-exemplaar.
De optiesparameters.
Retouren
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Controleer of de naam van een IoT-hub beschikbaar is.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parameters
- operationInputs
- OperationInputs
Stel de naamparameter in de structuur OperationInputs in op de naam van de IoT-hub die moet worden gecontroleerd.
De optiesparameters.
Retouren
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Voeg een consumentengroep toe aan een Event Hub-compatibel eindpunt in een IoT-hub.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- eventHubEndpointName
-
string
De naam van het Event Hub-compatibele eindpunt in de IoT-hub.
- name
-
string
De naam van de toe te voegen consumentengroep.
De optiesparameters.
Retouren
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Een consumentengroep verwijderen uit een Event Hub-compatibel eindpunt in een IoT-hub.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- eventHubEndpointName
-
string
De naam van het Event Hub-compatibele eindpunt in de IoT-hub.
- name
-
string
De naam van de consumentengroep die moet worden verwijderd.
De optiesparameters.
Retouren
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Hiermee exporteert u alle apparaatidentiteiten in het IoT Hub-identiteitsregister naar een Azure Storage-blobcontainer. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- exportDevicesParameters
- ExportDevicesRequest
De parameters waarmee de bewerking voor het exporteren van apparaten wordt opgegeven.
De optiesparameters.
Retouren
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Haal de niet-beveiligingsgerelateerde metagegevens van een IoT-hub op.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- options
- IotHubResourceGetOptionalParams
De optiesparameters.
Retouren
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Haal een consumentengroep op uit het event hub-compatibele apparaat-naar-cloud-eindpunt voor een IoT-hub.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- eventHubEndpointName
-
string
De naam van het Event Hub-compatibele eindpunt in de IoT-hub.
- name
-
string
De naam van de consumentengroep die moet worden opgehaald.
De optiesparameters.
Retouren
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Haal de details van een taak op uit een IoT-hub. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry voor meer informatie.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- jobId
-
string
De taak-id.
De optiesparameters.
Retouren
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Een beleid voor gedeelde toegang op naam ophalen uit een IoT-hub. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security voor meer informatie.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- keyName
-
string
De naam van het beleid voor gedeelde toegang.
De optiesparameters.
Retouren
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Haal de statistieken op uit een IoT-hub.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Apparaat-id's in het IoT Hub-identiteitsregister importeren, bijwerken of verwijderen uit een blob. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- importDevicesParameters
- ImportDevicesRequest
De parameters waarmee de bewerking voor het importeren van apparaten wordt opgegeven.
De optiesparameters.
Retouren
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Alle IoT-hubs in een resourcegroep ophalen.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
De optiesparameters.
Retouren
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Haal alle IoT-hubs in een abonnement op.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parameters
De optiesparameters.
Retouren
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Haal de status op voor routeringseindpunten.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parameters
- resourceGroupName
-
string
- iotHubName
-
string
De optiesparameters.
Retouren
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Haal een lijst op van de consumentengroepen in het event hub-compatibele apparaat-naar-cloud-eindpunt in een IoT-hub.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
- eventHubEndpointName
-
string
De naam van het Event Hub-compatibele eindpunt.
De optiesparameters.
Retouren
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Een lijst met alle taken in een IoT-hub ophalen. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry voor meer informatie.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Haal de beveiligingsmetagegevens voor een IoT-hub op. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security voor meer informatie.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Haal de metrische quotumgegevens voor een IoT-hub op.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Haal de lijst met geldige SKU's voor een IoT-hub op.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep die de IoT-hub bevat.
- resourceName
-
string
De naam van de IoT-hub.
De optiesparameters.
Retouren
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Alle routes testen die zijn geconfigureerd in deze IoT Hub
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parameters
- iotHubName
-
string
IotHub moet worden getest
- resourceGroupName
-
string
resourcegroep waartoe IoT Hub behoort
- input
- TestAllRoutesInput
Invoer voor het testen van alle routes
De optiesparameters.
Retouren
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
De nieuwe route voor deze IoT-hub testen
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parameters
- iotHubName
-
string
IotHub moet worden getest
- resourceGroupName
-
string
resourcegroep waartoe IoT Hub behoort
- input
- TestRouteInput
Route die moet worden getest
De optiesparameters.
Retouren
Promise<TestRouteResult>