@azure/arm-mongocluster package

Klasy

MongoClusterManagementClient

Interfejsy

CheckNameAvailabilityRequest	Treść żądania sprawdzania dostępności.
CheckNameAvailabilityResponse	Wynik sprawdzania dostępności.
ConnectionString	Parametry połączenia dla klastra mongo
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
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.
FirewallRule	Reprezentuje regułę zapory klastra mongo.
FirewallRuleProperties	Właściwości reguły zapory klastra mongo.
FirewallRulesCreateOrUpdateOptionalParams	Parametry opcjonalne.
FirewallRulesDeleteOptionalParams	Parametry opcjonalne.
FirewallRulesGetOptionalParams	Parametry opcjonalne.
FirewallRulesListByMongoClusterOptionalParams	Parametry opcjonalne.
FirewallRulesOperations	Interfejs reprezentujący operacje FirewallRules.
ListConnectionStringsResult	Parametry połączenia dla danego klastra mongo.
MongoCluster	Reprezentuje zasób klastra mongo.
MongoClusterManagementClientOptionalParams	Parametry opcjonalne dla klienta.
MongoClusterProperties	Właściwości klastra mongo.
MongoClusterRestoreParameters	Parametry używane do operacji przywracania
MongoClusterUpdate	Typ używany do operacji aktualizacji klastra MongoCluster.
MongoClusterUpdateProperties	Możliwe do zaktualizowania właściwości elementu MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Parametry opcjonalne.
MongoClustersCreateOrUpdateOptionalParams	Parametry opcjonalne.
MongoClustersDeleteOptionalParams	Parametry opcjonalne.
MongoClustersGetOptionalParams	Parametry opcjonalne.
MongoClustersListByResourceGroupOptionalParams	Parametry opcjonalne.
MongoClustersListConnectionStringsOptionalParams	Parametry opcjonalne.
MongoClustersListOptionalParams	Parametry opcjonalne.
MongoClustersOperations	Interfejs reprezentujący operacje MongoClusters.
MongoClustersUpdateOptionalParams	Parametry opcjonalne.
NodeGroupSpec	Specyfikacja grupy węzłów.
Operation	Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów
OperationDisplay	Zlokalizowane informacje o wyświetlaniu i operacji.
OperationsListOptionalParams	Parametry opcjonalne.
OperationsOperations	Interfejs reprezentujący operacje.
PageSettings	Opcje dla metody byPage
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.
PrivateEndpoint	Zasób prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia prywatnego punktu końcowego
PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionResource	Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.
PrivateEndpointConnectionsCreateOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsDeleteOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsGetOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsOperations	Interfejs reprezentujący operacje PrivateEndpointConnections.
PrivateLinkResource	Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.
PrivateLinkResourceProperties	Właściwości zasobu łącza prywatnego.
PrivateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.
PrivateLinksListByMongoClusterOptionalParams	Parametry opcjonalne.
PrivateLinksOperations	Interfejs reprezentujący operacje PrivateLinks.
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
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
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ę"

Aliasy typu

ActionType	Rozszerzalne wyliczenie. Wskazuje typ akcji. "Wewnętrzny" odnosi się do akcji, które są przeznaczone tylko dla wewnętrznych interfejsów API. KnownActionType można używać zamiennie z właściwością ActionType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę wewnętrzne
CheckNameAvailabilityReason	Możliwe przyczyny braku dostępności nazwy. KnownCheckNameAvailabilityReason można używać zamiennie z checkNameAvailabilityReason, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę nieprawidłowy AlreadyExists
ContinuablePage	Interfejs opisujący stronę wyników.
CreateMode	Tryb, za pomocą którego jest tworzony klaster Mongo. KnownCreateMode można używać zamiennie z trybem CreateMode, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę domyślne PointInTimeRestore
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żytkownika aplikacji ManagedIdentity key
MongoClusterStatus	Stan zasobu klastra Mongo. KnownMongoClusterStatus można używać zamiennie z mongoClusterStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Gotowe aprowizacja aktualizowanie uruchamianie zatrzymywanie zatrzymane upuszczanie
NodeKind	Rodzaj węzła w klastrze. KnownNodeKind można używać zamiennie z elementem NodeKind, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę fragmentów
Origin	Zamierzony wykonawca operacji; podobnie jak w przypadku kontroli dostępu opartej na zasobach (RBAC) i dzienników inspekcji środowiska użytkownika. Wartość domyślna to "użytkownik,system" ZnaneOrigin można używać zamiennie z usługą Origin, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę użytkownika systemu użytkownik , system
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji. KnownPrivateEndpointConnectionProvisioningState można używać zamiennie z parametrem PrivateEndpointConnectionProvisioningState. Wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę powodzeniem tworzenie usuwanie niepowodzenie
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego. KnownPrivateEndpointServiceConnectionStatus można używać zamiennie z parametrem PrivateEndpointServiceConnectionStatus. Wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę oczekujące zatwierdzone odrzucone
ProvisioningState	Alias dla provisioningState
PublicNetworkAccess	Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra Mongo. Wartość jest opcjonalna, a wartość domyślna to "Włączone" 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
ResourceProvisioningState	Stan aprowizacji typu zasobu. KnownResourceProvisioningState można używać zamiennie z parametrem ResourceProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę powodzeniem niepowodzenie anulowane
Versions	Dostępne wersje interfejsu API.

Wyliczenia

KnownActionType	Znane wartości ActionType akceptowane przez usługę.
KnownCheckNameAvailabilityReason	Znane wartości CheckNameAvailabilityReason akceptowane przez usługę.
KnownCreateMode	Znane wartości CreateMode akceptowane przez usługę.
KnownCreatedByType	Znane wartości CreatedByType akceptowane przez usługę.
KnownMongoClusterStatus	Znane wartości MongoClusterStatus, które akceptuje usługa.
KnownNodeKind	Znane wartości NodeKind akceptowane przez usługę.
KnownOrigin	Znane wartości Origin akceptowane przez usługę.
KnownPrivateEndpointConnectionProvisioningState	Znane wartości PrivateEndpointConnectionProvisioningState, które akceptuje usługa.
KnownPrivateEndpointServiceConnectionStatus	Znane wartości PrivateEndpointServiceConnectionStatus, które akceptuje usługa.
KnownPublicNetworkAccess	Znane wartości PublicNetworkAccess akceptowane przez usługę.
KnownResourceProvisioningState	Znane wartości ResourceProvisioningState akceptowane przez usługę.

Funkcje

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Szczegóły funkcji

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

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

Parametry

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Zwraca

PollerLike<OperationState<TResult>, TResult>