Freigeben über


@azure/arm-deviceprovisioningservices package

Klassen

IotDpsClient

Schnittstellen

AsyncOperationResult

Ergebnis eines lang andauernden Vorgangs.

CertificateBodyDescription

Das JSON-serialisierte X509-Zertifikat.

CertificateListDescription

Das JSON-serialisierte Array von Zertifikatobjekten.

CertificateProperties

Die Beschreibung eines X509-Zertifizierungsstellenzertifikats.

CertificateResponse

Das X509-Zertifikat.

DpsCertificate

Schnittstelle, die eine DpsCertificate darstellt.

DpsCertificateCreateOrUpdateOptionalParams

Optionale Parameter.

DpsCertificateDeleteOptionalParams

Optionale Parameter.

DpsCertificateGenerateVerificationCodeOptionalParams

Optionale Parameter.

DpsCertificateGetOptionalParams

Optionale Parameter.

DpsCertificateListOptionalParams

Optionale Parameter.

DpsCertificateVerifyCertificateOptionalParams

Optionale Parameter.

ErrorDetails

Fehlerdetails.

ErrorMessage

Fehlerantwort mit Nachricht und Code.

GroupIdInformation

Die Gruppeninformationen zum Erstellen eines privaten Endpunkts in einem Bereitstellungsdienst

GroupIdInformationProperties

Die Eigenschaften für ein Gruppeninformationsobjekt

IotDpsClientOptionalParams

Optionale Parameter.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktueller Zustand und systemgenerierte Eigenschaften wie Hostname und idScope

IotDpsResource

Schnittstelle, die eine IotDpsResource darstellt.

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Optionale Parameter.

IotDpsResourceCreateOrUpdateOptionalParams

Optionale Parameter.

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Optionale Parameter.

IotDpsResourceDeleteOptionalParams

Optionale Parameter.

IotDpsResourceDeletePrivateEndpointConnectionHeaders

Definiert Header für IotDpsResource_deletePrivateEndpointConnection Vorgang.

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Optionale Parameter.

IotDpsResourceGetOperationResultOptionalParams

Optionale Parameter.

IotDpsResourceGetOptionalParams

Optionale Parameter.

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Optionale Parameter.

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Optionale Parameter.

IotDpsResourceListByResourceGroupNextOptionalParams

Optionale Parameter.

IotDpsResourceListByResourceGroupOptionalParams

Optionale Parameter.

IotDpsResourceListBySubscriptionNextOptionalParams

Optionale Parameter.

IotDpsResourceListBySubscriptionOptionalParams

Optionale Parameter.

IotDpsResourceListKeysForKeyNameOptionalParams

Optionale Parameter.

IotDpsResourceListKeysNextOptionalParams

Optionale Parameter.

IotDpsResourceListKeysOptionalParams

Optionale Parameter.

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Optionale Parameter.

IotDpsResourceListPrivateLinkResourcesOptionalParams

Optionale Parameter.

IotDpsResourceListValidSkusNextOptionalParams

Optionale Parameter.

IotDpsResourceListValidSkusOptionalParams

Optionale Parameter.

IotDpsResourceUpdateOptionalParams

Optionale Parameter.

IotDpsSkuDefinition

Verfügbare SKUs für Ebene und Einheiten.

IotDpsSkuDefinitionListResult

Liste der verfügbaren SKUs.

IotDpsSkuInfo

Liste der möglichen Bereitstellungsdienst-SKUs.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

IpFilterRule

Die IP-Filterregeln für einen Bereitstellungsdienst.

NameAvailabilityInfo

Beschreibung der Namensverfügbarkeit.

Operation

Rest-API-Vorgang des Bereitstellungsdiensts.

OperationDisplay

Das -Objekt, das den Vorgang darstellt.

OperationInputs

Eingabewerte für den Aufruf von Vorgangsergebnissen.

OperationListResult

Ergebnis der Anforderung zum Auflisten von Bereitstellungsdienstvorgängen. Sie enthält eine Liste der Vorgänge und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

Operations

Schnittstelle, die einen Vorgang darstellt.

OperationsListNextOptionalParams

Optionale Parameter.

OperationsListOptionalParams

Optionale Parameter.

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

PrivateLinkResources

Die verfügbaren Private Link-Ressourcen für einen Bereitstellungsdienst

PrivateLinkServiceConnectionState

Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

ProvisioningServiceDescriptionListResult

Liste der Beschreibungen des Bereitstellungsdiensts.

Resource

Die allgemeinen Eigenschaften einer Azure-Ressource.

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Beschreibung des gemeinsam genutzten Zugriffsschlüssels.

SharedAccessSignatureAuthorizationRuleListResult

Liste der freigegebenen Zugriffsschlüssel.

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

TagsResource

Ein Container, der nur die Tags für eine Ressource enthält, sodass der Benutzer die Tags auf einer Bereitstellungsdienstinstanz aktualisieren kann.

VerificationCodeRequest

Das JSON-serialisierte Blattzertifikat

VerificationCodeResponse

Beschreibung der Antwort des Überprüfungscodes.

VerificationCodeResponseProperties

Typaliase

AccessRightsDescription

Definiert Werte für AccessRightsDescription.
KnownAccessRightsDescription kann austauschbar mit AccessRightsDescription verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Definiert Werte für AllocationPolicy.
KnownAllocationPolicy kann austauschbar mit AllocationPolicy verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Hash
Geolatenz
Statisch

CertificatePurpose

Definiert Werte für CertificatePurpose.
KnownCertificatePurpose kann austauschbar mit CertificatePurpose verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

clientAuthentication
serverAuthentication

CreatedByType

Definiert Werte für CreatedByType.
KnownCreatedByType kann austauschbar mit CreatedByType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer
Anwendung
ManagedIdentity
Schlüssel

DpsCertificateCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

DpsCertificateGenerateVerificationCodeResponse

Enthält Antwortdaten für den GenerateVerificationCode-Vorgang.

DpsCertificateGetResponse

Enthält Antwortdaten für den Get-Vorgang.

DpsCertificateListResponse

Enthält Antwortdaten für den Listenvorgang.

DpsCertificateVerifyCertificateResponse

Enthält Antwortdaten für den VerifyCertificate-Vorgang.

IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse

Enthält Antwortdaten für den Vorgang checkProvisioningServiceNameAvailability.

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse

Enthält Antwortdaten für den CreateOrUpdatePrivateEndpointConnection-Vorgang.

IotDpsResourceCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

IotDpsResourceDeletePrivateEndpointConnectionResponse

Enthält Antwortdaten für den DeletePrivateEndpointConnection-Vorgang.

IotDpsResourceGetOperationResultResponse

Enthält Antwortdaten für den getOperationResult-Vorgang.

IotDpsResourceGetPrivateEndpointConnectionResponse

Enthält Antwortdaten für den GetPrivateEndpointConnection-Vorgang.

IotDpsResourceGetPrivateLinkResourcesResponse

Enthält Antwortdaten für den GetPrivateLinkResources-Vorgang.

IotDpsResourceGetResponse

Enthält Antwortdaten für den Get-Vorgang.

IotDpsResourceListByResourceGroupNextResponse

Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang.

IotDpsResourceListByResourceGroupResponse

Enthält Antwortdaten für den ListByResourceGroup-Vorgang.

IotDpsResourceListBySubscriptionNextResponse

Enthält Antwortdaten für den ListBySubscriptionNext-Vorgang.

IotDpsResourceListBySubscriptionResponse

Enthält Antwortdaten für den listBySubscription-Vorgang.

IotDpsResourceListKeysForKeyNameResponse

Enthält Antwortdaten für den ListKeysForKeyName-Vorgang.

IotDpsResourceListKeysNextResponse

Enthält Antwortdaten für den ListKeysNext-Vorgang.

IotDpsResourceListKeysResponse

Enthält Antwortdaten für den listKeys-Vorgang.

IotDpsResourceListPrivateEndpointConnectionsResponse

Enthält Antwortdaten für den ListPrivateEndpointConnections-Vorgang.

IotDpsResourceListPrivateLinkResourcesResponse

Enthält Antwortdaten für den ListPrivateLinkResources-Vorgang.

IotDpsResourceListValidSkusNextResponse

Enthält Antwortdaten für den ListValidSkusNext-Vorgang.

IotDpsResourceListValidSkusResponse

Enthält Antwortdaten für den ListValidSkus-Vorgang.

IotDpsResourceUpdateResponse

Enthält Antwortdaten für den Aktualisierungsvorgang.

IotDpsSku

Definiert Werte für IotDpsSku.
KnownIotDpsSku kann austauschbar mit IotDpsSku verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

S1

IpFilterActionType

Definiert Werte für IpFilterActionType.

IpFilterTargetType

Definiert Werte für IpFilterTargetType.

NameUnavailabilityReason

Definiert Werte für NameUnavailabilityReason.
KnownNameUnavailabilityReason kann austauschbar mit NameUnavailabilityReason verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Ungültig
AlreadyExists

OperationsListNextResponse

Enthält Antwortdaten für den ListNext-Vorgang.

OperationsListResponse

Enthält Antwortdaten für den Listenvorgang.

PrivateLinkServiceConnectionStatus

Definiert Werte für PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus kann austauschbar mit PrivateLinkServiceConnectionStatus verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Ausstehend
Genehmigt
Rejected (Abgelehnt)
Nicht verbunden

PublicNetworkAccess

Definiert Werte für PublicNetworkAccess.
KnownPublicNetworkAccess kann austauschbar mit PublicNetworkAccess verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Aktiviert
Disabled

State

Definiert Werte für State.
KnownState kann austauschbar mit State verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Wird aktiviert
Aktiv
Wird gelöscht.
Gelöscht
ActivationFailed
DeleteFailed
Im Übergang
Wird angehalten
Angehalten
Wird fortgesetzt
FailingOver
FailoverFailed

Enumerationen

KnownAccessRightsDescription

Bekannte Werte von AccessRightsDescription , die der Dienst akzeptiert.

KnownAllocationPolicy

Bekannte Werte von AllocationPolicy , die der Dienst akzeptiert.

KnownCertificatePurpose

Bekannte Werte von CertificatePurpose , die der Dienst akzeptiert.

KnownCreatedByType

Bekannte Werte von CreatedByType , die der Dienst akzeptiert.

KnownIotDpsSku

Bekannte Werte von IotDpsSku , die der Dienst akzeptiert.

KnownNameUnavailabilityReason

Bekannte Werte von NameUnavailabilityReason , die der Dienst akzeptiert.

KnownPrivateLinkServiceConnectionStatus

Bekannte Werte von PrivateLinkServiceConnectionStatus , die der Dienst akzeptiert.

KnownPublicNetworkAccess

Bekannte Werte von PublicNetworkAccess , die der Dienst akzeptiert.

KnownState

Bekannte Werte des Zustands , den der Dienst akzeptiert.

Functions

getContinuationToken(unknown)

Gibt bei der letzten .value , die byPage vom Iterator erzeugt wurde, ein Fortsetzungstoken zurück, das später verwendet werden kann, um mit dem Paging zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Gibt bei der letzten .value , die byPage vom Iterator erzeugt wurde, ein Fortsetzungstoken zurück, das später verwendet werden kann, um mit dem Paging zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt, das von einem byPage Iterator aus auf iteratorResult zugreiftvalue.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.