Database Accounts - List By Resource Group

リファレンス

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

特定のリソースグループで使用可能なすべての Azure Cosmos DB データベースアカウントをListsします。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts?api-version=2023-11-15

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	DatabaseAccountsListResult	操作は正常に完了しました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

CosmosDBDatabaseAccountListByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts?api-version=2023-11-15

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_database_account_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.database_accounts.list_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json
func ExampleDatabaseAccountsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDatabaseAccountsClient().NewListByResourceGroupPager("rg1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DatabaseAccountsListResult = armcosmos.DatabaseAccountsListResult{
		// 	Value: []*armcosmos.DatabaseAccountGetResults{
		// 		{
		// 			Name: to.Ptr("ddb1"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Identity: &armcosmos.ManagedServiceIdentity{
		// 				Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
		// 				PrincipalID: to.Ptr("52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656"),
		// 				TenantID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
		// 				UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
		// 					"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
		// 						ClientID: to.Ptr("fbe75b66-01c5-4f87-a220-233af3270436"),
		// 						PrincipalID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
		// 					},
		// 				},
		// 			},
		// 			Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
		// 			Properties: &armcosmos.DatabaseAccountGetProperties{
		// 				ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
		// 					DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
		// 					MaxIntervalInSeconds: to.Ptr[int32](5),
		// 					MaxStalenessPrefix: to.Ptr[int64](100),
		// 				},
		// 				Cors: []*armcosmos.CorsPolicy{
		// 				},
		// 				DatabaseAccountOfferType: to.Ptr("Standard"),
		// 				DefaultIdentity: to.Ptr("FirstPartyIdentity"),
		// 				DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
		// 				DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
		// 				EnableFreeTier: to.Ptr(false),
		// 				FailoverPolicies: []*armcosmos.FailoverPolicy{
		// 					{
		// 						FailoverPriority: to.Ptr[int32](0),
		// 						ID: to.Ptr("ddb1-eastus"),
		// 						LocationName: to.Ptr("East US"),
		// 				}},
		// 				IPRules: []*armcosmos.IPAddressOrRange{
		// 				},
		// 				KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
		// 					PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
		// 						GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
		// 					},
		// 					PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
		// 						GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
		// 					},
		// 					SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
		// 						GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
		// 					},
		// 					SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
		// 						GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
		// 					},
		// 				},
		// 				Locations: []*armcosmos.Location{
		// 					{
		// 						DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
		// 						FailoverPriority: to.Ptr[int32](0),
		// 						ID: to.Ptr("ddb1-eastus"),
		// 						LocationName: to.Ptr("East US"),
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 				}},
		// 				MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
		// 				NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassNone),
		// 				NetworkACLBypassResourceIDs: []*string{
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ReadLocations: []*armcosmos.Location{
		// 					{
		// 						DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
		// 						FailoverPriority: to.Ptr[int32](0),
		// 						ID: to.Ptr("ddb1-eastus"),
		// 						LocationName: to.Ptr("East US"),
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 				}},
		// 				WriteLocations: []*armcosmos.Location{
		// 					{
		// 						DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
		// 						FailoverPriority: to.Ptr[int32](0),
		// 						ID: to.Ptr("ddb1-eastus"),
		// 						LocationName: to.Ptr("East US"),
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all the Azure Cosmos DB database accounts available under the given resource group.
 *
 * @summary Lists all the Azure Cosmos DB database accounts available under the given resource group.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json
 */
async function cosmosDbDatabaseAccountListByResourceGroup() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.databaseAccounts.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
      "name": "ddb1",
      "location": "West US",
      "type": "Microsoft.DocumentDB/databaseAccounts",
      "kind": "GlobalDocumentDB",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "documentEndpoint": "https://ddb1.documents.azure.com:443/",
        "ipRules": [],
        "databaseAccountOfferType": "Standard",
        "disableKeyBasedMetadataWriteAccess": false,
        "consistencyPolicy": {
          "defaultConsistencyLevel": "Session",
          "maxIntervalInSeconds": 5,
          "maxStalenessPrefix": 100
        },
        "writeLocations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "readLocations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "locations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "failoverPolicies": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "failoverPriority": 0
          }
        ],
        "cors": [],
        "enableFreeTier": false,
        "defaultIdentity": "FirstPartyIdentity",
        "networkAclBypass": "None",
        "networkAclBypassResourceIds": [],
        "keysMetadata": {
          "primaryMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "secondaryMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "primaryReadonlyMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "secondaryReadonlyMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          }
        },
        "minimalTlsVersion": "Tls"
      },
      "identity": {
        "type": "SystemAssigned,UserAssigned",
        "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
        "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
        "userAssignedIdentities": {
          "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
            "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
            "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
          }
        }
      }
    }
  ]
}

定義

名前	説明
AccountKeyMetadata	特定のデータベースアカウントのアクセスキーに関連するメタデータ。
AnalyticalStorageConfiguration	分析ストレージ固有のプロパティ。
AnalyticalStorageSchemaType	分析ストレージのスキーマの種類について説明します。
ApiProperties
BackupPolicyMigrationState	バックアップポリシー間の移行の状態を表すオブジェクト。
BackupPolicyMigrationStatus	バックアップポリシーの種類間の移行の状態について説明します。
BackupPolicyType	バックアップのモードについて説明します。
BackupStorageRedundancy	バックアップストレージの冗長性の種類を示す列挙型。
Capability	Cosmos DB 機能オブジェクト
Capacity	アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。
ConnectorOffer	Cosmos DB C* データベースアカウントの cassandra コネクタオファーの種類。
ConsistencyPolicy	Cosmos DB データベースアカウントの整合性ポリシー。
ContinuousModeBackupPolicy	連続モードバックアップポリシーを表すオブジェクト。
ContinuousModeProperties	定期モードバックアップの構成値
ContinuousTier	継続的バックアップ層の種類を示す列挙型。
CorsPolicy	Cosmos DB データベースアカウントの CORS ポリシー。
createdByType	リソースを作成した ID の種類。
CreateMode	アカウントの作成モードを示す列挙型。
DatabaseAccountGetResults	Azure Cosmos DB データベースアカウント。
DatabaseAccountKeysMetadata	指定された Cosmos DB データベースアカウントの各アクセスキーに関連するメタデータ。
DatabaseAccountKind	データベースアカウントの種類を示します。これは、データベースアカウントの作成時にのみ設定できます。
DatabaseAccountOfferType	Cosmos DB データベースアカウントのオファーの種類。
DatabaseAccountsListResult	データベースアカウントとそのプロパティを含む List 操作の応答。
DatabaseRestoreResource	復元する特定のデータベース。
DefaultConsistencyLevel	Cosmos DB アカウントの既定の整合性レベルと構成設定。
FailoverPolicy	データベースアカウントの特定のリージョンのフェールオーバーポリシー。
GremlinDatabaseRestoreResource	復元する特定の Gremlin データベース。
IpAddressOrRange	IpAddressOrRange オブジェクト
Location	Azure Cosmos DB データベースアカウントがデプロイされているリージョン。
ManagedServiceIdentity	リソースの ID。
MinimalTlsVersion	許可されている Tls の最小バージョンを示します。既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。
NetworkAclBypass	ファイアウォールチェックをバイパスできるサービスを示します。
PeriodicModeBackupPolicy	定期的なモードのバックアップポリシーを表すオブジェクト。
PeriodicModeProperties	定期モードバックアップの構成値
PrivateEndpointConnection	プライベートエンドポイント接続
PrivateEndpointProperty	接続が属するプライベートエンドポイント。
PrivateLinkServiceConnectionStateProperty	プライベートエンドポイント接続の接続状態。
PublicNetworkAccess	パブリックネットワークからの要求を許可するかどうか
ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。
RestoreMode	復元のモードについて説明します。
RestoreParameters	復元に関する情報を示すパラメーター。
ServerVersion	MongoDB アカウントの ServerVersion について説明します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
VirtualNetworkRule	VIRTUAL NETWORK ACL Rule オブジェクト

AccountKeyMetadata

特定のデータベースアカウントのアクセスキーに関連するメタデータ。

名前	型	説明
generationTime	string	ISO-8601 形式のキーの UTC での生成時間。オブジェクトに値がない場合は、最後のキー再生成が 2022-06-18 より前にトリガーされたことを意味します。

AnalyticalStorageConfiguration

分析ストレージ固有のプロパティ。

名前	型	説明
schemaType	AnalyticalStorageSchemaType	分析ストレージのスキーマの種類について説明します。

AnalyticalStorageSchemaType

分析ストレージのスキーマの種類について説明します。

名前	型	説明
FullFidelity	string
WellDefined	string

ApiProperties

名前	型	説明
serverVersion	ServerVersion	MongoDB アカウントの ServerVersion について説明します。

BackupPolicyMigrationState

バックアップポリシー間の移行の状態を表すオブジェクト。

名前	型	説明
startTime	string	バックアップポリシーの移行が開始された時刻 (ISO-8601 形式)。
status	BackupPolicyMigrationStatus	バックアップポリシーの種類間の移行の状態について説明します。
targetType	BackupPolicyType	バックアップポリシー移行のターゲットバックアップポリシーの種類について説明します。

BackupPolicyMigrationStatus

バックアップポリシーの種類間の移行の状態について説明します。

名前	型	説明
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

バックアップのモードについて説明します。

名前	型	説明
Continuous	string
Periodic	string

BackupStorageRedundancy

バックアップストレージの冗長性の種類を示す列挙型。

名前	型	説明
Geo	string
Local	string
Zone	string

Capability

Cosmos DB 機能オブジェクト

名前	型	説明
name	string	Cosmos DB 機能の名前。たとえば、"name": "EnableCassandra" です。現在の値には、"EnableTable" と "EnableGremlin" も含まれます。

Capacity

アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。

名前	型	説明
totalThroughputLimit	integer	アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。

ConnectorOffer

Cosmos DB C* データベースアカウントの cassandra コネクタオファーの種類。

名前	型	説明
Small	string

ConsistencyPolicy

Cosmos DB データベースアカウントの整合性ポリシー。

名前	型	説明
defaultConsistencyLevel	DefaultConsistencyLevel	Cosmos DB アカウントの既定の整合性レベルと構成設定。
maxIntervalInSeconds	integer	有界整合性整合性レベルで使用する場合、この値は許容される制約の時間 (秒単位) を表します。この値の許容範囲は 5 ~ 86400 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。
maxStalenessPrefix	integer	有界整合性整合性レベルで使用する場合、この値は許容される古い要求の数を表します。この値の許容範囲は、1 ～ 2,147,483,647 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。

ContinuousModeBackupPolicy

連続モードバックアップポリシーを表すオブジェクト。

名前	型	説明
continuousModeProperties	ContinuousModeProperties	連続モードバックアップの構成値
migrationState	BackupPolicyMigrationState	バックアップポリシー間の移行の状態を表すオブジェクト。
type	string: Continuous	バックアップのモードについて説明します。

ContinuousModeProperties

定期モードバックアップの構成値

名前	型	説明
tier	ContinuousTier	継続的バックアップモードの種類を示す列挙型

ContinuousTier

継続的バックアップ層の種類を示す列挙型。

名前	型	説明
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Cosmos DB データベースアカウントの CORS ポリシー。

名前	型	説明
allowedHeaders	string	元のドメインが CORS 要求に指定できる要求ヘッダー。
allowedMethods	string	元のドメインが CORS 要求で使用できるメソッド (HTTP 要求の動詞)。
allowedOrigins	string	CORS 経由でサービスに対して要求を行うことができます。
exposedHeaders	string	CORS 要求への応答で送信され、ブラウザーが要求の発行元に公開できる応答ヘッダー。
maxAgeInSeconds	integer	ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

アカウントの作成モードを示す列挙型。

名前	型	説明
Default	string
Restore	string

DatabaseAccountGetResults

Azure Cosmos DB データベースアカウント。

名前	型	既定値	説明
id	string		ARM リソースの一意のリソース識別子。
identity	ManagedServiceIdentity		リソースの ID。
kind	DatabaseAccountKind	GlobalDocumentDB	データベースアカウントの種類を示します。これは、データベースアカウントの作成時にのみ設定できます。
location	string		リソースが属しているリソースグループの場所。
name	string		ARM リソースの名前。
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		分析ストレージ固有のプロパティ。
properties.apiProperties	ApiProperties		API 固有のプロパティ。
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		アカウントでバックアップを作成するためのポリシーを表すオブジェクト。
properties.capabilities	Capability[]		アカウントの Cosmos DB 機能の一覧
properties.capacity	Capacity		アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。
properties.connectorOffer	ConnectorOffer		Cosmos DB データベース C* アカウントの cassandra コネクタオファーの種類。
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB データベースアカウントの整合性ポリシー。
properties.cors	CorsPolicy[]		Cosmos DB データベースアカウントの CORS ポリシー。
properties.createMode	CreateMode	Default	アカウントの作成モードを示す列挙型。
properties.customerManagedKeyStatus	string		アカウントのカスタマーマネージドキー機能の状態を示します。エラーが発生した場合は、プロパティでトラブルシューティングガイダンスが提供されます。
properties.databaseAccountOfferType	DatabaseAccountOfferType		Cosmos DB データベースアカウントのオファーの種類。既定値: Standard。
properties.defaultIdentity	string		カスタマーマネージドキーなどの機能で使用されるキーコンテナーにアクセスするための既定の ID。既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などです。
properties.disableKeyBasedMetadataWriteAccess	boolean		アカウントキーを使用してメタデータリソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする
properties.disableLocalAuth	boolean		ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できるようにします。
properties.documentEndpoint	string		Cosmos DB データベースアカウントの接続エンドポイント。
properties.enableAnalyticalStorage	boolean		ストレージ分析を有効にするかどうかを示すフラグ。
properties.enableAutomaticFailover	boolean		障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。自動フェールオーバーにより、アカウントの新しい書き込みリージョンが作成され、アカウントに構成されているフェールオーバーの優先順位に基づいて選択されます。
properties.enableBurstCapacity	boolean		アカウントでのバースト容量プレビュー機能の有効化/無効化を示すフラグ
properties.enableCassandraConnector	boolean		Cosmos DB C* アカウントで cassandra コネクタを有効にします
properties.enableFreeTier	boolean		Free レベルが有効かどうかを示すフラグ。
properties.enableMultipleWriteLocations	boolean		アカウントを複数の場所に書き込むことができます
properties.enablePartitionMerge	boolean		アカウントでのパーティションマージ機能の有効化/無効化を示すフラグ
properties.failoverPolicies	FailoverPolicy[]		フェールオーバーの優先順位で並べ替えられたリージョンを含む配列。
properties.instanceId	string		データベースアカウントに割り当てられた一意識別子
properties.ipRules	IpAddressOrRange[]		IpRules の一覧。
properties.isVirtualNetworkFilterEnabled	boolean		VIRTUAL NETWORK ACL 規則を有効または無効にするかどうかを示すフラグ。
properties.keyVaultKeyUri	string		キーコンテナーの URI
properties.keysMetadata	DatabaseAccountKeysMetadata		Cosmos DB アカウントのアカウントキーのメタデータを表すオブジェクト。
properties.locations	Location[]		Cosmos DB アカウントで有効になっているすべての場所を含む配列。
properties.minimalTlsVersion	MinimalTlsVersion		許可されている Tls の最小バージョンを示します。既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。
properties.networkAclBypass	NetworkAclBypass		ファイアウォールチェックをバイパスできるサービスを示します。
properties.networkAclBypassResourceIds	string[]		Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
properties.privateEndpointConnections	PrivateEndpointConnection[]		Cosmos DB アカウント用に構成Connectionsプライベートエンドポイントの一覧。
properties.provisioningState	string		操作が呼び出されたときの Cosmos DB アカウントの状態。状態は次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeletionFailed' – Cosmos DB アカウントの削除に失敗しました。
properties.publicNetworkAccess	PublicNetworkAccess		パブリックネットワークからの要求を許可するかどうか
properties.readLocations	Location[]		Cosmos DB アカウントで有効になっている読み取り場所を含む配列。
properties.restoreParameters	RestoreParameters		復元に関する情報を示すパラメーター。
properties.virtualNetworkRules	VirtualNetworkRule[]		Cosmos DB アカウント用に構成Virtual Network ACL 規則の一覧。
properties.writeLocations	Location[]		Cosmos DB アカウントの書き込み場所を含む配列。
systemData	systemData		このリソースに関連するシステムメタデータ。
tags	object		タグは、リソースを記述するキーと値のペアの一覧です。これらのタグはリソースグループをまたがってこのリソースを表示およびグループ化する際に使用できます。リソースには最大 15 個のタグを指定できます。各タグには 128 文字以内のキーと、256 文字以内の値が必要です。たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
type	string		Azure リソースの種類。

DatabaseAccountKeysMetadata

指定された Cosmos DB データベースアカウントの各アクセスキーに関連するメタデータ。

名前	型	説明
primaryMasterKey	AccountKeyMetadata	指定された Cosmos DB データベースアカウントのプライマリ Read-Write キーに関連するメタデータ。
primaryReadonlyMasterKey	AccountKeyMetadata	指定された Cosmos DB データベースアカウントのプライマリ Read-Only キーに関連するメタデータ。
secondaryMasterKey	AccountKeyMetadata	指定された Cosmos DB データベースアカウントのセカンダリ Read-Write キーに関連するメタデータ。
secondaryReadonlyMasterKey	AccountKeyMetadata	指定された Cosmos DB データベースアカウントのセカンダリ Read-Only キーに関連するメタデータ。

DatabaseAccountKind

データベースアカウントの種類を示します。これは、データベースアカウントの作成時にのみ設定できます。

名前	型	説明
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Cosmos DB データベースアカウントのオファーの種類。

名前	型	説明
Standard	string

DatabaseAccountsListResult

データベースアカウントとそのプロパティを含む List 操作の応答。

名前	型	説明
value	DatabaseAccountGetResults[]	データベースアカウントとそのプロパティの一覧。

DatabaseRestoreResource

復元する特定のデータベース。

名前	型	説明
collectionNames	string[]	復元に使用できるコレクションの名前。
databaseName	string	復元に使用できるデータベースの名前。

DefaultConsistencyLevel

Cosmos DB アカウントの既定の整合性レベルと構成設定。

名前	型	説明
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

データベースアカウントの特定のリージョンのフェールオーバーポリシー。

名前	型	説明
failoverPriority	integer	リージョンのフェールオーバー優先度。フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。フェールオーバー優先度の値は、データベースアカウントが存在するリージョンごとに一意である必要があります。
id	string	データベースアカウントがレプリケートされるリージョンの一意識別子。例: <accountName-locationName>><。
locationName	string	データベースアカウントが存在するリージョンの名前。

GremlinDatabaseRestoreResource

復元する特定の Gremlin データベース。

名前	型	説明
databaseName	string	復元に使用できる gremlin データベースの名前。
graphNames	string[]	復元に使用できるグラフの名前。

IpAddressOrRange

IpAddressOrRange オブジェクト

名前	型	説明
ipAddressOrRange	string	CIDR 形式の単一の IPv4 アドレスまたは単一の IPv4 アドレス範囲。 IP は適切な形式である必要があり、10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16 のいずれかの範囲に含めることはできません。これらは IP アドレスフィルターによって適用できないためです。有効な入力の例: "23.40.210.245" または "23.40.210.0/8"

Location

Azure Cosmos DB データベースアカウントがデプロイされているリージョン。

名前	型	説明
documentEndpoint	string	特定のリージョンの接続エンドポイント。例: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	リージョンのフェールオーバー優先度。フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。フェールオーバー優先度の値は、データベースアカウントが存在するリージョンごとに一意である必要があります。
id	string	データベースアカウント内のリージョンの一意識別子。例: <accountName-locationName>><。
isZoneRedundant	boolean	このリージョンが AvailabilityZone リージョンであるかどうかを示すフラグ
locationName	string	領域の名前。
provisioningState	string	操作が呼び出されたときの Cosmos DB アカウントの状態。状態は次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeletionFailed' – Cosmos DB アカウントの削除に失敗しました。

ManagedServiceIdentity

リソースの ID。

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
type	ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。
userAssignedIdentities	UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

MinimalTlsVersion

許可されている Tls の最小バージョンを示します。既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。

名前	型	説明
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

ファイアウォールチェックをバイパスできるサービスを示します。

名前	型	説明
AzureServices	string
None	string

PeriodicModeBackupPolicy

定期的なモードのバックアップポリシーを表すオブジェクト。

名前	型	説明
migrationState	BackupPolicyMigrationState	バックアップポリシー間の移行の状態を表すオブジェクト。
periodicModeProperties	PeriodicModeProperties	定期モードバックアップの構成値
type	string: Periodic	バックアップのモードについて説明します。

PeriodicModeProperties

定期モードバックアップの構成値

名前	型	説明
backupIntervalInMinutes	integer	2 つのバックアップ間の間隔を分単位で表す整数
backupRetentionIntervalInHours	integer	各バックアップが保持される時間 (時間単位) を表す整数
backupStorageRedundancy	BackupStorageRedundancy	バックアップ所在地の種類を示す列挙型

PrivateEndpointConnection

プライベートエンドポイント接続

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.groupId	string	プライベートエンドポイントのグループ ID。
properties.privateEndpoint	PrivateEndpointProperty	接続が属するプライベートエンドポイント。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	プライベートエンドポイント接続の接続状態。
properties.provisioningState	string	プライベートエンドポイントのプロビジョニング状態。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

接続が属するプライベートエンドポイント。

名前	型	説明
id	string	プライベートエンドポイントのリソース ID。

PrivateLinkServiceConnectionStateProperty

プライベートエンドポイント接続の接続状態。

名前	型	説明
actionsRequired	string	基本的なワークフローを超えて必要なアクション (承認/拒否/切断)
description	string	プライベートリンクサービス接続の説明。
status	string	プライベートリンクサービスの接続状態。

PublicNetworkAccess

パブリックネットワークからの要求を許可するかどうか

名前	型	説明
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

復元のモードについて説明します。

名前	型	説明
PointInTime	string

RestoreParameters

復元に関する情報を示すパラメーター。

名前	型	説明
databasesToRestore	DatabaseRestoreResource[]	復元に使用できる特定のデータベースの一覧。
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	復元に使用できる特定の gremlin データベースの一覧。
restoreMode	RestoreMode	復元のモードについて説明します。
restoreSource	string	復元を開始する必要がある復元可能なデータベースアカウントの ID。例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	アカウントを復元する必要がある時間 (ISO-8601 形式)。
tablesToRestore	string[]	復元に使用できる特定のテーブルの一覧。

ServerVersion

MongoDB アカウントの ServerVersion について説明します。

名前	型	説明
3.2	string
3.6	string
4.0	string
4.2	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明

VirtualNetworkRule

VIRTUAL NETWORK ACL Rule オブジェクト

名前	型	説明
id	string	サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。
ignoreMissingVNetServiceEndpoint	boolean	仮想ネットワークで vnet サービスエンドポイントが有効にする前に、ファイアウォール規則を作成します。

Database Accounts - List By Resource Group

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

CosmosDBDatabaseAccountListByResourceGroup

Sample Request

Sample Response

定義

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountsListResult

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

その他のリソース