@azure/arm-deviceprovisioningservices package

Klasy

IotDpsClient

Interfejsy

AsyncOperationResult	Wynik długotrwałej operacji.
CertificateListDescription	Tablica serializowana w formacie JSON obiektów Certyfikat.
CertificateProperties	Opis certyfikatu urzędu certyfikacji X509.
CertificateResponse	Certyfikat X509.
DpsCertificateCreateOrUpdateOptionalParams	Parametry opcjonalne.
DpsCertificateDeleteOptionalParams	Parametry opcjonalne.
DpsCertificateGenerateVerificationCodeOptionalParams	Parametry opcjonalne.
DpsCertificateGetOptionalParams	Parametry opcjonalne.
DpsCertificateListOptionalParams	Parametry opcjonalne.
DpsCertificateOperations	Interfejs reprezentujący operacje DpsCertificate.
DpsCertificateVerifyCertificateOptionalParams	Parametry opcjonalne.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorDetails	Szczegóły błędu.
ErrorMessage	Odpowiedź na błąd zawierająca komunikat i kod.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.
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 dla klienta.
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
IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams	Parametry opcjonalne.
IotDpsResourceCreateOrUpdateOptionalParams	Parametry opcjonalne.
IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams	Parametry opcjonalne.
IotDpsResourceDeleteOptionalParams	Parametry opcjonalne.
IotDpsResourceDeletePrivateEndpointConnectionOptionalParams	Parametry opcjonalne.
IotDpsResourceGetOperationResultOptionalParams	Parametry opcjonalne.
IotDpsResourceGetOptionalParams	Parametry opcjonalne.
IotDpsResourceGetPrivateEndpointConnectionOptionalParams	Parametry opcjonalne.
IotDpsResourceGetPrivateLinkResourcesOptionalParams	Parametry opcjonalne.
IotDpsResourceListByResourceGroupOptionalParams	Parametry opcjonalne.
IotDpsResourceListBySubscriptionOptionalParams	Parametry opcjonalne.
IotDpsResourceListKeysForKeyNameOptionalParams	Parametry opcjonalne.
IotDpsResourceListKeysOptionalParams	Parametry opcjonalne.
IotDpsResourceListPrivateEndpointConnectionsOptionalParams	Parametry opcjonalne.
IotDpsResourceListPrivateLinkResourcesOptionalParams	Parametry opcjonalne.
IotDpsResourceListValidSkusOptionalParams	Parametry opcjonalne.
IotDpsResourceOperations	Interfejs reprezentujący operacje IotDpsResource.
IotDpsResourceUpdateOptionalParams	Parametry opcjonalne.
IotDpsSkuDefinition	Dostępne jednostki SKU warstwy i jednostek.
IotDpsSkuInfo	Lista możliwych jednostek SKU usługi aprowizacji.
IotHubDefinitionDescription	Opis centrum IoT.
IpFilterRule	Reguły filtrowania adresów IP dla usługi aprowizacji.
ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
NameAvailabilityInfo	Opis dostępności nazwy.
Operation	Reprezentuje operację.
OperationInputs	Wartości wejściowe wywołania wyników operacji.
OperationsListOptionalParams	Parametry opcjonalne.
OperationsOperations	Interfejs reprezentujący operacje Operations.
PageSettings	Opcje metody byPage
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.
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.
ProxyResource	Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji
Resource	Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager
RestorePollerOptions
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Opis klucza 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.
TrackedResource	Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika
VerificationCodeRequest	Certyfikat liści serializowanego w formacie JSON
VerificationCodeResponse	Opis odpowiedzi kodu weryfikacyjnego.
VerificationCodeResponseProperties	interfejs modelu VerificationCodeResponseProperties

Aliasy typu

AccessRightsDescription	Prawa, które ma ten klucz. 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	Zasady alokacji, które mają być używane przez tę usługę aprowizacji. 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
AzureSupportedClouds	Obsługiwane wartości ustawienia chmury jako typ literału ciągu
CertificatePurpose	Typ certyfikatuCel
ContinuablePage	Interfejs opisujący stronę wyników.
CreatedByType	Rodzaj jednostki, która utworzyła zasób. 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żytkownik: Encja została utworzona przez użytkownika. Aplikacja: Jednostka została utworzona przez aplikację. ManagedIdentity: jednostka została utworzona przez tożsamość zarządzaną. Klucz: Jednostka została utworzona za pomocą klucza.
IotDpsSku	Nazwa jednostki SKU. 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
IotHubAuthenticationType	Typ uwierzytelniania IotHub MI: KeyBased, UserAssigned, SystemAssigned. KnownIotHubAuthenticationType może być używany zamiennie z IotHubAuthenticationType, a ten enum zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę KeyBased: Typ uwierzytelniania opartego na kluczu. UserAssigned: typ uwierzytelniania przypisany przez użytkownika. SystemAssigned: typ uwierzytelniania przypisany przez system.
IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
IpFilterTargetType	Element docelowy dla żądań przechwyconych przez tę regułę.
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). KnownManagedServiceIdentityType można używać zamiennie z wartościami ManagedServiceIdentityType. Wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Brak: Brak tożsamości zarządzanej. SystemAssigned: tożsamość zarządzana przypisana przez system. UserAssigned: tożsamość zarządzana przypisana przez użytkownika. SystemAssigned,UserAssigned: tożsamość zarządzana przypisana przez system i użytkownika.
NameUnavailabilityReason	Określa przyczynę niedostępności nazwy 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
PrivateLinkServiceConnectionStatus	Stan połączenia z prywatnym punktem końcowym 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	Czy żądania z sieci publicznej są dozwolone 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	Bieżący stan usługi aprowizacji. 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

AzureClouds	Wyliczenie opisujące środowiska chmury platformy Azure.
KnownAccessRightsDescription	Prawa, które ma ten klucz.
KnownAllocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.
KnownCertificatePurpose	Znane wartości CertificatePurpose akceptowane przez usługę.
KnownCreatedByType	Rodzaj jednostki, która utworzyła zasób.
KnownIotDpsSku	Nazwa jednostki SKU.
KnownIotHubAuthenticationType	Typ uwierzytelniania IotHub MI: KeyBased, UserAssigned, SystemAssigned.
KnownManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
KnownNameUnavailabilityReason	Określa przyczynę niedostępności nazwy
KnownPrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego
KnownPublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
KnownState	Bieżący stan usługi aprowizacji.
KnownVersions	Dostępne wersje interfejsu API.

Funkcje

isRestError(unknown)	Funkcja Typeguard dla błędu RestError
restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

function restorePoller<TResponse, TResult>(client: IotDpsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

client

IotDpsClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ

RestErrorConstructor