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 serializowana 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 informacyjnego grupy

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 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 nazwy.

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świetlenia 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 łącza 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 dla zasobu, który umożliwia użytkownikowi aktualizowanie tagów w wystąpieniu usługi Provisioning Service.

VerificationCodeRequest

Certyfikat liści serializowanego w formacie JSON

VerificationCodeResponse

Opis odpowiedzi kodu weryfikacyjnego.

VerificationCodeResponseProperties

Aliasy typu

AccessRightsDescription

Definiuje wartości dla parametru AccessRightsDescription.
KnownAccessRightsDescription można używać zamiennie z programem AccessRightsDescription, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Definiuje wartości elementu AllocationPolicy.
ZnaneAllocationPolicy można używać zamiennie z funkcją AllocationPolicy. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

skrótu
geolatency
statyczne

CertificatePurpose

Definiuje wartości dla atrybutu CertificatePurpose.
KnownCertificatePurpose można używać zamiennie z użyciem elementu CertificatePurpose, 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.
KnownCreatedByType można używać zamiennie z parametrem CreatedByType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

użytkownika
aplikacji
ManagedIdentity
key

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 IotDpsSku.
KnownIotDpsSku można używać zamiennie z protokołem IotDpsSku, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

S1

IpFilterActionType

Definiuje wartości typu IpFilterActionType.

IpFilterTargetType

Definiuje wartości właściwości IpFilterTargetType.

NameUnavailabilityReason

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

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

nieprawidłowy
AlreadyExists

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. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

oczekujące
zatwierdzone
odrzucone
rozłączone

PublicNetworkAccess

Definiuje wartości dla funkcji PublicNetworkAccess.
ZnanePublicNetworkAccess można używać zamiennie z funkcją PublicNetworkAccess, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

włączone
wyłączone

State

Definiuje wartości stanu.
KnownState można używać zamiennie ze stanem, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

aktywowanie
Aktywne
usuwanie
usunięte
ActivationFailed
DeletionFailed
przechodzenie
zawieszanie
zawieszone
Wznawianie
trybu failover
failoverFailed

Wyliczenia

KnownAccessRightsDescription

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

KnownAllocationPolicy

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

KnownCertificatePurpose

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

KnownCreatedByType

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

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 PublicNetworkAccess akceptowane przez usługę.

KnownState

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

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez iterator byPage, 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 iterator byPage, 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 dostępu do value w iteratorzeResult z iteratora byPage.

Zwraca

string | undefined

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