Udostępnij za pośrednictwem


@azure/arm-deviceprovisioningservices package

Klasy

IotDpsClient

Interfejsy

AsyncOperationResult

Wynik długotrwałej operacji.

CertificateBodyDescription

Certyfikat X509 serializowany w formacie JSON.

CertificateListDescription

Tablica zserializowana w formacie JSON obiektów Certyfikat.

CertificateProperties

Opis certyfikatu urzędu certyfikacji X509.

CertificateResponse

Certyfikat X509.

DpsCertificate

Interfejs reprezentujący element DpsCertificate.

DpsCertificateCreateOrUpdateOptionalParams

Parametry opcjonalne.

DpsCertificateDeleteOptionalParams

Parametry opcjonalne.

DpsCertificateGenerateVerificationCodeOptionalParams

Parametry opcjonalne.

DpsCertificateGetOptionalParams

Parametry opcjonalne.

DpsCertificateListOptionalParams

Parametry opcjonalne.

DpsCertificateVerifyCertificateOptionalParams

Parametry opcjonalne.

ErrorDetails

Szczegóły błędu.

ErrorMessage

Odpowiedź na błąd zawierająca komunikat i kod.

GroupIdInformation

Informacje o grupie dotyczące tworzenia prywatnego punktu końcowego w usłudze aprowizacji

GroupIdInformationProperties

Właściwości obiektu informacji o grupie

IotDpsClientOptionalParams

Parametry opcjonalne.

IotDpsPropertiesDescription

właściwości specyficzne dla usługi aprowizacji, w tym klucze, połączone centra iot, bieżący stan i system wygenerowane właściwości, takie jak nazwa hosta i idScope

IotDpsResource

Interfejs reprezentujący element IotDpsResource.

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Parametry opcjonalne.

IotDpsResourceCreateOrUpdateOptionalParams

Parametry opcjonalne.

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parametry opcjonalne.

IotDpsResourceDeleteOptionalParams

Parametry opcjonalne.

IotDpsResourceDeletePrivateEndpointConnectionHeaders

Definiuje nagłówki dla operacji IotDpsResource_deletePrivateEndpointConnection.

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parametry opcjonalne.

IotDpsResourceGetOperationResultOptionalParams

Parametry opcjonalne.

IotDpsResourceGetOptionalParams

Parametry opcjonalne.

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Parametry opcjonalne.

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Parametry opcjonalne.

IotDpsResourceListByResourceGroupNextOptionalParams

Parametry opcjonalne.

IotDpsResourceListByResourceGroupOptionalParams

Parametry opcjonalne.

IotDpsResourceListBySubscriptionNextOptionalParams

Parametry opcjonalne.

IotDpsResourceListBySubscriptionOptionalParams

Parametry opcjonalne.

IotDpsResourceListKeysForKeyNameOptionalParams

Parametry opcjonalne.

IotDpsResourceListKeysNextOptionalParams

Parametry opcjonalne.

IotDpsResourceListKeysOptionalParams

Parametry opcjonalne.

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Parametry opcjonalne.

IotDpsResourceListPrivateLinkResourcesOptionalParams

Parametry opcjonalne.

IotDpsResourceListValidSkusNextOptionalParams

Parametry opcjonalne.

IotDpsResourceListValidSkusOptionalParams

Parametry opcjonalne.

IotDpsResourceUpdateOptionalParams

Parametry opcjonalne.

IotDpsSkuDefinition

Dostępne jednostki SKU warstwy i jednostek.

IotDpsSkuDefinitionListResult

Lista dostępnych jednostek SKU.

IotDpsSkuInfo

Lista możliwych jednostek SKU usługi aprowizacji.

IotHubDefinitionDescription

Opis centrum IoT.

IpFilterRule

Reguły filtrowania adresów IP dla usługi aprowizacji.

NameAvailabilityInfo

Opis dostępności nazw.

Operation

Operacja interfejsu API REST usługi aprowizacji.

OperationDisplay

Obiekt reprezentujący operację.

OperationInputs

Wartości wejściowe wywołania wyników operacji.

OperationListResult

Wynik żądania wyświetlania listy operacji usługi aprowizacji. Zawiera listę operacji i link adresu URL, aby uzyskać następny zestaw wyników.

Operations

Interfejs reprezentujący operacje.

OperationsListNextOptionalParams

Parametry opcjonalne.

OperationsListOptionalParams

Parametry opcjonalne.

PrivateEndpoint

Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego usługi aprowizacji

PrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego

PrivateLinkResources

Dostępne zasoby linku prywatnego dla usługi aprowizacji

PrivateLinkServiceConnectionState

Bieżący stan połączenia prywatnego punktu końcowego

ProvisioningServiceDescription

Opis usługi aprowizacji.

ProvisioningServiceDescriptionListResult

Lista opisów usług aprowizacji.

Resource

Typowe właściwości zasobu platformy Azure.

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Opis klucza dostępu współdzielonego.

SharedAccessSignatureAuthorizationRuleListResult

Lista kluczy dostępu współdzielonego.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TagsResource

Kontener zawierający tylko tagi zasobu, który umożliwia użytkownikowi aktualizowanie tagów w wystąpieniu usługi Provisioning Service.

VerificationCodeRequest

Certyfikat liścia serializowanego w formacie JSON

VerificationCodeResponse

Opis odpowiedzi kodu weryfikacyjnego.

VerificationCodeResponseProperties

Aliasy typu

AccessRightsDescription

Definiuje wartości dla właściwości AccessRightsDescription.
KnownAccessRightsDescription można używać zamiennie z accessRightsDescription. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Serviceconfig
EnrollmentRead
RejestracjaWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Definiuje wartości właściwości AllocationPolicy.
ZnaneAllocationPolicy można używać zamiennie z allocationPolicy. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Mieszany
GeoLatency
Statyczny

CertificatePurpose

Definiuje wartości elementu CertificatePurpose.
KnownCertificatePurpose można używać zamiennie z użyciem elementu CertificatePurpose. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

clientAuthentication
serverAuthentication

CreatedByType

Definiuje wartości createdByType.
Typ KnownCreatedByType może być używany zamiennie z parametrem CreatedByType. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Użytkownik
Aplikacja
ManagedIdentity
Klucz

DpsCertificateCreateOrUpdateResponse

Zawiera dane odpowiedzi dla operacji createOrUpdate.

DpsCertificateGenerateVerificationCodeResponse

Zawiera dane odpowiedzi dla operacji generateVerificationCode.

DpsCertificateGetResponse

Zawiera dane odpowiedzi dla operacji pobierania.

DpsCertificateListResponse

Zawiera dane odpowiedzi dla operacji listy.

DpsCertificateVerifyCertificateResponse

Zawiera dane odpowiedzi dla operacji verifyCertificate.

IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse

Zawiera dane odpowiedzi dla operacji checkProvisioningServiceNameAvailability.

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse

Zawiera dane odpowiedzi dla operacji createOrUpdatePrivateEndpointConnection.

IotDpsResourceCreateOrUpdateResponse

Zawiera dane odpowiedzi dla operacji createOrUpdate.

IotDpsResourceDeletePrivateEndpointConnectionResponse

Zawiera dane odpowiedzi dla operacji deletePrivateEndpointConnection.

IotDpsResourceGetOperationResultResponse

Zawiera dane odpowiedzi dla operacji getOperationResult.

IotDpsResourceGetPrivateEndpointConnectionResponse

Zawiera dane odpowiedzi dla operacji getPrivateEndpointConnection.

IotDpsResourceGetPrivateLinkResourcesResponse

Zawiera dane odpowiedzi dla operacji getPrivateLinkResources.

IotDpsResourceGetResponse

Zawiera dane odpowiedzi dla operacji pobierania.

IotDpsResourceListByResourceGroupNextResponse

Zawiera dane odpowiedzi dla operacji listByResourceGroupNext.

IotDpsResourceListByResourceGroupResponse

Zawiera dane odpowiedzi dla operacji listByResourceGroup.

IotDpsResourceListBySubscriptionNextResponse

Zawiera dane odpowiedzi dla operacji listBySubscriptionNext.

IotDpsResourceListBySubscriptionResponse

Zawiera dane odpowiedzi dla operacji listBySubscription.

IotDpsResourceListKeysForKeyNameResponse

Zawiera dane odpowiedzi dla operacji listKeysForKeyName.

IotDpsResourceListKeysNextResponse

Zawiera dane odpowiedzi dla operacji listKeysNext.

IotDpsResourceListKeysResponse

Zawiera dane odpowiedzi dla operacji listKeys.

IotDpsResourceListPrivateEndpointConnectionsResponse

Zawiera dane odpowiedzi dla operacji listPrivateEndpointConnections.

IotDpsResourceListPrivateLinkResourcesResponse

Zawiera dane odpowiedzi dla operacji listPrivateLinkResources.

IotDpsResourceListValidSkusNextResponse

Zawiera dane odpowiedzi dla operacji listValidSkusNext.

IotDpsResourceListValidSkusResponse

Zawiera dane odpowiedzi dla operacji listValidSkus.

IotDpsResourceUpdateResponse

Zawiera dane odpowiedzi dla operacji aktualizacji.

IotDpsSku

Definiuje wartości dla IotDpsSku.
ZnaneIotDpsSku można używać zamiennie z protokołem IotDpsSku. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

S1

IpFilterActionType

Definiuje wartości ipFilterActionType.

IpFilterTargetType

Definiuje wartości ipFilterTargetType.

NameUnavailabilityReason

Definiuje wartości nameUnavailabilityReason.
ZnaneNameUnavailabilityReason można używać zamiennie z nameUnavailabilityReason. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieprawidłowy
Jużexists

OperationsListNextResponse

Zawiera dane odpowiedzi dla operacji listDalej.

OperationsListResponse

Zawiera dane odpowiedzi dla operacji listy.

PrivateLinkServiceConnectionStatus

Definiuje wartości parametru PrivateLinkServiceConnectionStatus.
ZnanePrivateLinkServiceConnectionStatus można używać zamiennie z parametrem PrivateLinkServiceConnectionStatus. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Oczekujące
Approved (Zatwierdzono)
Odrzucone
Odłączony

PublicNetworkAccess

Definiuje wartości dla funkcji PublicNetworkAccess.
Funkcja KnownPublicNetworkAccess może być używana zamiennie z funkcją PublicNetworkAccess. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Włączono
Disabled

State

Definiuje wartości stanu.
Funkcja KnownState może być używana zamiennie ze stanem. Ta wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Aktywowanie
Aktywny
Usuwanie
Usunięta
AktywacjaFailed
UsuwanieFailed
Przejście
Zawieszanie
Suspended
Wznawianie
Tryb failover
Tryb failoverFailed

Wyliczenia

KnownAccessRightsDescription

Znane wartości programu AccessRightsDescription , które akceptuje usługa.

KnownAllocationPolicy

Znane wartości AllocationPolicy akceptowane przez usługę.

KnownCertificatePurpose

Znane wartości certificatePurpose , które akceptuje usługa.

KnownCreatedByType

Znane wartości CreatedByType , które akceptuje usługa.

KnownIotDpsSku

Znane wartości IotDpsSku , które akceptuje usługa.

KnownNameUnavailabilityReason

Znane wartości NameUnavailabilityReason , które akceptuje usługa.

KnownPrivateLinkServiceConnectionStatus

Znane wartości PrivateLinkServiceConnectionStatus , które akceptuje usługa.

KnownPublicNetworkAccess

Znane wartości funkcji PublicNetworkAccess , które akceptuje usługa.

KnownState

Znane wartości stanu , które akceptuje usługa.

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

Szczegóły funkcji

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Obiekt z uzyskiwania value dostępu do iteratoraresult z iteratora byPage .

Zwraca

string | undefined

Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.