@azure/arm-mongocluster package
인터페이스
| AdministratorProperties |
로컬 관리자 로그인 속성입니다. |
| AuthConfigProperties |
Mongo 클러스터에 대한 인증 구성입니다. |
| BackupProperties |
클러스터의 백업 속성입니다. 여기에는 가장 빠른 복원 시간 및 보존 설정이 포함됩니다. |
| CheckNameAvailabilityRequest |
가용성 요청 본문 확인입니다. |
| CheckNameAvailabilityResponse |
가용성 확인 결과입니다. |
| ComputeProperties |
클러스터의 컴퓨팅 속성입니다. 여기에는 클러스터의 서버에 적용되는 가상 코어/메모리 및 크기 조정 옵션이 포함됩니다. |
| ConnectionString |
mongo 클러스터에 대한 연결 문자열 |
| CustomerManagedKeyEncryptionProperties |
고객 관리형 키 암호화 설정. |
| DataApiProperties |
데이터 API 속성. |
| DatabaseRole |
사용자에게 할당된 데이터베이스 역할 정의입니다. |
| EncryptionProperties |
mongo 클러스터의 암호화 구성입니다. |
| EntraIdentityProvider |
Microsoft Entra ID Mongo 사용자를 정의합니다. |
| EntraIdentityProviderProperties |
Microsoft Entra ID 공급자 속성. |
| ErrorAdditionalInfo |
리소스 관리 오류 추가 정보입니다. |
| ErrorDetail |
오류 세부 정보입니다. |
| ErrorResponse |
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. |
| FirewallRule |
mongo 클러스터 방화벽 규칙을 나타냅니다. |
| FirewallRuleProperties |
mongo 클러스터 방화벽 규칙의 속성입니다. |
| FirewallRulesCreateOrUpdateOptionalParams |
선택적 매개 변수입니다. |
| FirewallRulesDeleteOptionalParams |
선택적 매개 변수입니다. |
| FirewallRulesGetOptionalParams |
선택적 매개 변수입니다. |
| FirewallRulesListByMongoClusterOptionalParams |
선택적 매개 변수입니다. |
| FirewallRulesOperations |
FirewallRules 작업을 나타내는 인터페이스입니다. |
| HighAvailabilityProperties |
클러스터의 고가용성 속성입니다. |
| IdentityProvider |
사용자의 ID 공급자 정의를 정의합니다. |
| KeyEncryptionKeyIdentity |
키 암호화 키에 사용되는 ID입니다. |
| ListConnectionStringsResult |
지정된 mongo 클러스터에 대한 연결 문자열입니다. |
| ManagedServiceIdentity |
관리 서비스 ID(시스템 할당 및/또는 사용자 할당 ID) |
| MongoCluster |
mongo 클러스터 리소스를 나타냅니다. |
| MongoClusterManagementClientOptionalParams |
클라이언트에 대한 선택적 매개 변수입니다. |
| MongoClusterProperties |
mongo 클러스터의 속성입니다. |
| MongoClusterReplicaParameters |
복제본 작업에 사용되는 매개 변수입니다. |
| MongoClusterRestoreParameters |
복원 작업에 사용되는 매개 변수 |
| MongoClusterUpdate |
MongoCluster의 업데이트 작업에 사용되는 형식입니다. |
| MongoClusterUpdateProperties |
MongoCluster의 업트래블 속성입니다. |
| MongoClustersCheckNameAvailabilityOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersCreateOrUpdateOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersDeleteOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersGetOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersListByResourceGroupOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersListConnectionStringsOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersListOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersOperations |
MongoClusters 작업을 나타내는 인터페이스입니다. |
| MongoClustersPromoteOptionalParams |
선택적 매개 변수입니다. |
| MongoClustersUpdateOptionalParams |
선택적 매개 변수입니다. |
| Operation |
리소스 공급자 작업 API에서 반환된 REST API 작업의 세부 정보 |
| OperationDisplay |
지역화된 표시 정보 및 작업에 대한 정보입니다. |
| OperationsListOptionalParams |
선택적 매개 변수입니다. |
| OperationsOperations |
작업 작업을 나타내는 인터페이스입니다. |
| PageSettings |
byPage 메서드에 대한 옵션 |
| PagedAsyncIterableIterator |
완료 및 페이지별로 비동기 반복 가능한 반복을 허용하는 인터페이스입니다. |
| PrivateEndpoint |
프라이빗 엔드포인트 리소스입니다. |
| PrivateEndpointConnection |
프라이빗 엔드포인트 연결 리소스 |
| PrivateEndpointConnectionProperties |
프라이빗 엔드포인트 연결의 속성입니다. |
| PrivateEndpointConnectionResource |
특정 속성 형식을 사용하여 이 형식의 별칭을 지정하여 구체적인 프록시 리소스 유형을 만들 수 있습니다. |
| PrivateEndpointConnectionsCreateOptionalParams |
선택적 매개 변수입니다. |
| PrivateEndpointConnectionsDeleteOptionalParams |
선택적 매개 변수입니다. |
| PrivateEndpointConnectionsGetOptionalParams |
선택적 매개 변수입니다. |
| PrivateEndpointConnectionsListByMongoClusterOptionalParams |
선택적 매개 변수입니다. |
| PrivateEndpointConnectionsOperations |
PrivateEndpointConnections 작업을 나타내는 인터페이스입니다. |
| PrivateLinkResource |
특정 속성 형식을 사용하여 이 형식의 별칭을 지정하여 구체적인 프록시 리소스 유형을 만들 수 있습니다. |
| PrivateLinkResourceProperties |
프라이빗 링크 리소스의 속성입니다. |
| PrivateLinkServiceConnectionState |
서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다. |
| PrivateLinksListByMongoClusterOptionalParams |
선택적 매개 변수입니다. |
| PrivateLinksOperations |
PrivateLinks 작업을 나타내는 인터페이스입니다. |
| PromoteReplicaRequest |
복제본 요청 속성을 승격합니다. |
| ProxyResource |
Azure Resource Manager 프록시 리소스에 대한 리소스 모델 정의입니다. 태그 및 위치가 없습니다. |
| Replica |
mongo 클러스터 복제본을 나타냅니다. |
| ReplicasListByParentOptionalParams |
선택적 매개 변수입니다. |
| ReplicasOperations |
복제본 작업을 나타내는 인터페이스입니다. |
| ReplicationProperties |
mongo 클러스터의 복제본 속성입니다. |
| Resource |
모든 Azure Resource Manager 리소스에 대한 응답에서 반환되는 공통 필드 |
| RestorePollerOptions | |
| ShardingProperties |
클러스터의 분할 속성입니다. 여기에는 클러스터에 대한 분할된 데이터베이스 수 및 크기 조정 옵션이 포함됩니다. |
| StorageProperties |
클러스터의 스토리지 속성입니다. 여기에는 클러스터의 서버에 적용되는 데이터 스토리지 크기 및 크기 조정이 포함됩니다. |
| SystemData |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
| TrackedResource |
Azure Resource Manager에 대한 리소스 모델 정의는 '태그'와 '위치'가 있는 최상위 리소스를 추적했습니다. |
| User |
Mongo 클러스터 사용자를 나타냅니다. |
| UserAssignedIdentity |
사용자 할당 ID 속성 |
| UserProperties |
클러스터에서 Mongo 사용자 리소스의 정의입니다. |
| UsersCreateOrUpdateOptionalParams |
선택적 매개 변수입니다. |
| UsersDeleteOptionalParams |
선택적 매개 변수입니다. |
| UsersGetOptionalParams |
선택적 매개 변수입니다. |
| UsersListByMongoClusterOptionalParams |
선택적 매개 변수입니다. |
| UsersOperations |
사용자 작업을 나타내는 인터페이스입니다. |
형식 별칭
| ActionType |
확장 가능한 열거형입니다. 작업 유형을 나타냅니다. "내부"는 내부 전용 API에 대한 작업을 나타냅니다. 서비스에서 지원하는 알려진 값내부: 작업은 내부 전용 API용입니다. |
| AuthenticationMode |
Mongo 클러스터에서 지원하는 인증 모드입니다. 서비스에서 지원하는 알려진 값
NativeAuth: 인증 메커니즘 'SCRAM-SHA-256'과 함께 사용자 이름과 암호를 사용하는 기본 mongo 인증 모드입니다. |
| AzureSupportedClouds |
문자열 리터럴 유형으로 클라우드 설정에 지원되는 값 |
| CheckNameAvailabilityReason |
이름을 사용할 수 없는 가능한 이유입니다. 서비스에서 지원하는 알려진 값
잘못된: 이름이 잘못되었습니다. |
| ContinuablePage |
결과 페이지를 설명하는 인터페이스입니다. |
| CreateMode |
Mongo 클러스터가 만들어지는 모드입니다. 서비스에서 지원하는 알려진 값
기본값: 새 mongo 클러스터를 만듭니다. |
| CreatedByType |
리소스를 만든 엔터티의 종류입니다. 서비스에서 지원하는 알려진 값
사용자: 사용자가 엔터티를 만들었습니다. |
| DataApiMode |
Mongo Data API에 적용할 모드입니다. 서비스에서 지원하는 알려진 값
사용: 클러스터에 대해 Mongo Data API가 사용하도록 설정되었습니다. |
| EntraPrincipalType |
Mongo 사용자가 사용할 수 있는 Microsoft Entra ID 보안 주체 유형입니다. 서비스에서 지원하는 알려진 값
user: Entra 사용자 유형입니다. |
| HighAvailabilityMode |
클러스터의 고가용성 모드입니다. 서비스에서 지원하는 알려진 값
사용 안 함: 고가용성 모드가 사용 안 함입니다. 이 모드는 장애 또는 유지 관리 중에 가용성 영향을 볼 수 있으며 프로덕션에는 권장되지 않습니다. |
| IdentityProviderType |
사용자 ID가 속할 수 있는 ID 공급자 유형입니다. 서비스에서 지원하는 알려진 값MicrosoftEntraID: Microsoft Entra ID 공급자입니다. |
| IdentityProviderUnion |
IdentityProviderUnion의 별칭 |
| KeyEncryptionKeyIdentityType |
키 암호화 키의 ID 유형입니다. 서비스에서 지원하는 알려진 값UserAssignedIdentity: 사용자 할당 ID입니다. |
| ManagedServiceIdentityType |
관리 서비스 ID의 유형입니다(SystemAssigned 및 UserAssigned 형식이 모두 허용되는 경우). 서비스에서 지원하는 알려진 값
없음: 관리 ID가 없습니다. |
| MongoClusterStatus |
Mongo 클러스터 리소스의 상태입니다. 서비스에서 지원하는 알려진 값
준비: mongo 클러스터 리소스를 사용할 준비가 되었습니다. |
| Origin |
작업의 의도된 실행기입니다. RBAC(리소스 기반 액세스 제어) 및 감사 로그 UX에서와 같습니다. 기본값은 "user,system"입니다. 서비스에서 지원하는 알려진 값
사용자: 사용자가 작업을 시작했음을 나타냅니다. |
| PreviewFeature |
mongo 클러스터에서 사용하도록 설정할 수 있는 미리 보기 기능입니다. 서비스에서 지원하는 알려진 값GeoReplicas: 지역 복제본 미리 보기 기능을 사용하도록 설정합니다. 지역 복제본 클러스터를 연결할 수 있도록 새 클러스터에서 만들 때 기능을 설정해야 합니다. |
| PrivateEndpointConnectionProvisioningState |
현재 프로비저닝 상태입니다. 서비스에서 지원하는 알려진 값
성공: 연결이 프로비전되었습니다. |
| PrivateEndpointServiceConnectionStatus |
프라이빗 엔드포인트 연결 상태입니다. 서비스에서 지원하는 알려진 값
보류 중: 승인 또는 거부를 기다리는 연결 |
| PromoteMode |
승격 작업에 적용할 모드입니다. 서비스에서 지원하는 알려진 값전환: 승격은 현재 복제본 클러스터를 기본 역할로 전환하고 원래 기본 클러스터는 복제본 역할로 전환되어 복제 링크를 유지합니다. |
| PromoteOption |
승격 작업에 적용할 옵션입니다. 서비스에서 지원하는 알려진 값강제: 승격 옵션은 복제본이 기본에 따라잡을 때까지 기다리지 않고 강제로 승격합니다. 이로 인해 데이터가 손실될 수 있으므로 재해 복구 시나리오 중에만 사용해야 합니다. |
| ProvisioningState |
마지막으로 허용된 작업의 프로비전 상태입니다. 서비스에서 지원하는 알려진 값
성공: 리소스가 생성되었습니다. |
| PublicNetworkAccess |
이 Mongo 클러스터에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이며 기본값은 'Enabled'입니다. 서비스에서 지원하는 알려진 값
사용: 설정된 경우 개인 및 공용 방법을 통해 mongo 클러스터에 액세스할 수 있습니다. |
| ReplicationRole |
mongo 클러스터의 복제 역할입니다. 서비스에서 지원하는 알려진 값
기본: 클러스터가 주 복제본입니다. |
| ReplicationState |
복제본과 원본 클러스터 간의 복제 링크 상태입니다. 서비스에서 지원하는 알려진 값
활성: 복제 링크가 활성 상태입니다. |
| StorageType |
mongo 클러스터를 프로비저닝할 수 있는 스토리지 유형입니다. 서비스에서 지원하는 알려진 값
PremiumSSD: 고성능 워크로드를 위한 프리미엄 SSD입니다. |
| UserRole |
사용자에게 할당할 수 있는 기본 제공 데이터베이스 역할입니다. 서비스에서 지원하는 알려진 값root: 대상 범위에 대한 루트 역할 권한입니다. |
열거형
| AzureClouds |
Azure 클라우드 환경을 설명하는 열거형입니다. |
| KnownActionType |
확장 가능한 열거형입니다. 작업 유형을 나타냅니다. "내부"는 내부 전용 API에 대한 작업을 나타냅니다. |
| KnownAuthenticationMode |
Mongo 클러스터에서 지원하는 인증 모드입니다. |
| KnownCheckNameAvailabilityReason |
이름을 사용할 수 없는 가능한 이유입니다. |
| KnownCreateMode |
Mongo 클러스터가 만들어지는 모드입니다. |
| KnownCreatedByType |
리소스를 만든 엔터티의 종류입니다. |
| KnownDataApiMode |
Mongo Data API에 적용할 모드입니다. |
| KnownEntraPrincipalType |
Mongo 사용자가 사용할 수 있는 Microsoft Entra ID 보안 주체 유형입니다. |
| KnownHighAvailabilityMode |
클러스터의 고가용성 모드입니다. |
| KnownIdentityProviderType |
사용자 ID가 속할 수 있는 ID 공급자 유형입니다. |
| KnownKeyEncryptionKeyIdentityType |
키 암호화 키의 ID 유형입니다. |
| KnownManagedServiceIdentityType |
관리 서비스 ID의 유형입니다(SystemAssigned 및 UserAssigned 형식이 모두 허용되는 경우). |
| KnownMongoClusterStatus |
Mongo 클러스터 리소스의 상태입니다. |
| KnownOrigin |
작업의 의도된 실행기입니다. RBAC(리소스 기반 액세스 제어) 및 감사 로그 UX에서와 같습니다. 기본값은 "user,system"입니다. |
| KnownPreviewFeature |
mongo 클러스터에서 사용하도록 설정할 수 있는 미리 보기 기능입니다. |
| KnownPrivateEndpointConnectionProvisioningState |
현재 프로비저닝 상태입니다. |
| KnownPrivateEndpointServiceConnectionStatus |
프라이빗 엔드포인트 연결 상태입니다. |
| KnownPromoteMode |
승격 작업에 적용할 모드입니다. |
| KnownPromoteOption |
승격 작업에 적용할 옵션입니다. |
| KnownProvisioningState |
마지막으로 허용된 작업의 프로비전 상태입니다. |
| KnownPublicNetworkAccess |
이 Mongo 클러스터에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이고 기본값은 '사용'입니다. |
| KnownReplicationRole |
mongo 클러스터의 복제 역할입니다. |
| KnownReplicationState |
복제본과 원본 클러스터 간의 복제 링크 상태입니다. |
| KnownStorageType |
mongo 클러스터를 프로비저닝할 수 있는 스토리지 유형입니다. |
| KnownUserRole |
사용자에게 할당할 수 있는 기본 제공 데이터베이스 역할입니다. |
| KnownVersions |
사용 가능한 API 버전입니다. |
함수
| restore |
다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다. |
함수 세부 정보
restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다.
function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
매개 변수
- client
- MongoClusterManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
반환
PollerLike<OperationState<TResult>, TResult>