DatabaseAccounts interface
DatabaseAccounts를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Azure Cosmos DB 데이터베이스 계정을 만들거나 업데이트합니다. 계정에서 업데이트를 수행할 때는 "Update" 메서드를 사용하는 것이 좋습니다.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
현재 데이터베이스 계정에 제공할 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Azure Cosmos DB 데이터베이스 계정을 만들거나 업데이트합니다. 계정에서 업데이트를 수행할 때는 "Update" 메서드를 사용하는 것이 좋습니다.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
현재 데이터베이스 계정에 제공할 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
기존 Azure Cosmos DB 데이터베이스 계정을 삭제합니다.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
기존 Azure Cosmos DB 데이터베이스 계정을 삭제합니다.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Azure Cosmos DB 데이터베이스 계정의 장애 조치(failover) 우선 순위를 변경합니다. 장애 조치(failover) 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- failoverParameters
- FailoverPolicies
데이터베이스 계정에 대한 새 장애 조치(failover) 정책입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Azure Cosmos DB 데이터베이스 계정의 장애 조치(failover) 우선 순위를 변경합니다. 장애 조치(failover) 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- failoverParameters
- FailoverPolicies
데이터베이스 계정에 대한 새 장애 조치(failover) 정책입니다.
옵션 매개 변수입니다.
반환
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대해 지정된 지역을 오프라인으로 전환합니다.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- regionParameterForOffline
- RegionForOnlineOffline
데이터베이스 계정에 대해 Cosmos DB 지역을 오프라인으로 전환합니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대해 지정된 지역을 오프라인으로 전환합니다.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- regionParameterForOffline
- RegionForOnlineOffline
데이터베이스 계정에 대해 Cosmos DB 지역을 오프라인으로 전환합니다.
옵션 매개 변수입니다.
반환
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대해 지정된 지역을 온라인으로 설정합니다.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- regionParameterForOnline
- RegionForOnlineOffline
데이터베이스 계정에 대한 Cosmos DB 지역이 온라인 상태가 됩니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대해 지정된 지역을 온라인으로 설정합니다.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- regionParameterForOnline
- RegionForOnlineOffline
데이터베이스 계정에 대한 Cosmos DB 지역이 온라인 상태가 됩니다.
옵션 매개 변수입니다.
반환
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 액세스 키를 다시 생성합니다.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
다시 생성할 키의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 액세스 키를 다시 생성합니다.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
다시 생성할 키의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
기존 Azure Cosmos DB 데이터베이스 계정의 속성을 업데이트합니다.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- updateParameters
- DatabaseAccountUpdateParameters
현재 데이터베이스 계정에 제공할 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
기존 Azure Cosmos DB 데이터베이스 계정의 속성을 업데이트합니다.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- updateParameters
- DatabaseAccountUpdateParameters
현재 데이터베이스 계정에 제공할 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Azure Cosmos DB 계정 이름이 이미 있는지 확인합니다. 유효한 계정 이름은 소문자, 숫자 및 '-' 문자만 포함할 수 있으며 3자에서 50자 사이여야 합니다.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>매개 변수
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
get(string, string, DatabaseAccountsGetOptionalParams)
기존 Azure Cosmos DB 데이터베이스 계정의 속성을 검색합니다.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 읽기 전용 액세스 키를 나열합니다.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
list(DatabaseAccountsListOptionalParams)
구독에서 사용할 수 있는 모든 Azure Cosmos DB 데이터베이스 계정을 나열합니다.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>매개 변수
옵션 매개 변수입니다.
반환
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
지정된 리소스 그룹에서 사용할 수 있는 모든 Azure Cosmos DB 데이터베이스 계정을 나열합니다.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
옵션 매개 변수입니다.
반환
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 연결 문자열을 나열합니다.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 액세스 키를 나열합니다.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
지정된 데이터베이스 계정에 대한 메트릭 정의를 검색합니다.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
지정된 데이터베이스 계정에 대해 지정된 필터에 의해 결정되는 메트릭을 검색합니다.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
- filter
-
string
반환할 메트릭의 하위 집합을 설명하는 OData 필터 식입니다. 필터링할 수 있는 매개 변수는 name.value(메트릭 이름, 여러 이름을 가질 수 있음), startTime, endTime 및 timeGrain입니다. 지원되는 연산자는 eq입니다.
옵션 매개 변수입니다.
반환
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
지정된 Azure Cosmos DB 데이터베이스 계정에 대한 읽기 전용 액세스 키를 나열합니다.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.
반환
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
지정된 데이터베이스 계정에 대한 사용량(최신 데이터)을 검색합니다.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- accountName
-
string
Cosmos DB 데이터베이스 계정 이름입니다.
옵션 매개 변수입니다.