你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sql Resources - Create Update Sql Database

参考

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

创建或更新 Azure Cosmos DB SQL 数据库

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Cosmos DB 数据库帐户名称。 Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
databaseName	path	True	string	Cosmos DB 数据库名称。
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
createUpdateSqlDatabaseParameters	SqlDatabaseCreateUpdateParameters	要为当前 SQL 数据库提供的参数。

响应

名称	类型	说明
200 OK	SqlDatabaseGetResults	SQL 数据库创建或更新操作已成功完成。
202 Accepted		SQL 数据库创建或更新操作将以异步方式完成。 Headers azure-AsyncOperation: string location: string

名称

类型

说明

200 OK

SqlDatabaseGetResults

SQL 数据库创建或更新操作已成功完成。

202 Accepted

SQL 数据库创建或更新操作将以异步方式完成。

Headers

azure-AsyncOperation: string
location: string

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

CosmosDBSqlDatabaseCreateUpdate

Sample Request

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

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "databaseName"
    },
    "options": {}
  }
}


import com.azure.resourcemanager.cosmos.models.CreateUpdateOptions;
import com.azure.resourcemanager.cosmos.models.SqlDatabaseCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.SqlDatabaseResource;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for SqlResources CreateUpdateSqlDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBSqlDatabaseCreateUpdate.json
     */
    /**
     * Sample code: CosmosDBSqlDatabaseCreateUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBSqlDatabaseCreateUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getSqlResources().createUpdateSqlDatabase("rg1", "ddb1",
            "databaseName",
            new SqlDatabaseCreateUpdateParameters().withLocation("West US").withTags(mapOf())
                .withResource(new SqlDatabaseResource().withId("databaseName")).withOptions(new CreateUpdateOptions()),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

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_sql_database_create_update.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.sql_resources.begin_create_update_sql_database(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        create_update_sql_database_parameters={
            "location": "West US",
            "properties": {"options": {}, "resource": {"id": "databaseName"}},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseCreateUpdate.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/azcore/to"
	"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/CosmosDBSqlDatabaseCreateUpdate.json
func ExampleSQLResourcesClient_BeginCreateUpdateSQLDatabase() {
	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)
	}
	poller, err := clientFactory.NewSQLResourcesClient().BeginCreateUpdateSQLDatabase(ctx, "rg1", "ddb1", "databaseName", armcosmos.SQLDatabaseCreateUpdateParameters{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armcosmos.SQLDatabaseCreateUpdateProperties{
			Options: &armcosmos.CreateUpdateOptions{},
			Resource: &armcosmos.SQLDatabaseResource{
				ID: to.Ptr("databaseName"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLDatabaseGetResults = armcosmos.SQLDatabaseGetResults{
	// 	Name: to.Ptr("databaseName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlDatabases"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.SQLDatabaseGetProperties{
	// 		Resource: &armcosmos.SQLDatabaseGetPropertiesResource{
	// 			Etag: to.Ptr("\"00000a00-0000-0000-0000-56672f920000\""),
	// 			Rid: to.Ptr("CqNBAA=="),
	// 			Ts: to.Ptr[float32](1449602962),
	// 			ID: to.Ptr("databaseName"),
	// 		},
	// 	},
	// }
}

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 Create or update an Azure Cosmos DB SQL database
 *
 * @summary Create or update an Azure Cosmos DB SQL database
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseCreateUpdate.json
 */
async function cosmosDbSqlDatabaseCreateUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const createUpdateSqlDatabaseParameters = {
    location: "West US",
    options: {},
    resource: { id: "databaseName" },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.sqlResources.beginCreateUpdateSqlDatabaseAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    createUpdateSqlDatabaseParameters,
  );
  console.log(result);
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName",
  "name": "databaseName",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "databaseName",
      "_rid": "CqNBAA==",
      "_ts": 1449602962,
      "_etag": "\"00000a00-0000-0000-0000-56672f920000\""
    }
  }
}

Status code:: 202

定义

名称	说明
AutoscaleSettings
CreateMode	用于指示帐户创建模式的枚举。
CreateUpdateOptions	要为请求应用的选项的键值对。这对应于随请求一起发送的标头。
Options
Resource
ResourceRestoreParameters	指示有关还原的信息的参数。
SqlDatabaseCreateUpdateParameters	要为当前 SQL 数据库提供的参数。
SqlDatabaseGetResults	Azure Cosmos DB SQL 数据库。
SqlDatabaseResource	Cosmos DB SQL 数据库资源对象

AutoscaleSettings

名称	类型	说明
maxThroughput	integer	表示资源可纵向扩展的最大吞吐量。

CreateMode

用于指示帐户创建模式的枚举。

名称	类型	说明
Default	string
Restore	string

CreateUpdateOptions

要为请求应用的选项的键值对。这对应于随请求一起发送的标头。

名称	类型	说明
autoscaleSettings	AutoscaleSettings	指定自动缩放设置。注意：吞吐量或自动缩放设置是必需的，但不是两者兼而有之。
throughput	integer	每秒请求单位数。例如，“吞吐量”：10000。

Options

名称	类型	说明
autoscaleSettings	AutoscaleSettings	指定自动缩放设置。
throughput	integer	Cosmos DB 资源吞吐量或自动缩放设置的值。检索产品/服务详细信息时，请使用 ThroughputSetting 资源。

Resource

名称	类型	默认值	说明
_colls	string		一个系统生成的属性，该属性指定集合资源的可寻址路径。
_etag	string		表示乐观并发控制所需的资源 etag 的系统生成的属性。
_rid	string		系统生成的属性。唯一标识符。
_ts	number		一个系统生成的属性，表示资源的上次更新时间戳。
_users	string		一个系统生成的属性，指定用户资源的可寻址路径。
createMode	CreateMode	Default	用于指示资源创建模式的枚举。
id	string		Cosmos DB SQL 数据库的名称
restoreParameters	ResourceRestoreParameters		指示有关还原的信息的参数

ResourceRestoreParameters

指示有关还原的信息的参数。

名称	类型	说明
restoreSource	string	必须从中启动还原的可还原数据库帐户的 ID。例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	帐户必须还原到的时间 (ISO-8601 格式) 。

SqlDatabaseCreateUpdateParameters

要为当前 SQL 数据库提供的参数。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
location	string	资源所属的资源组的位置。
name	string	ARM 资源的名称。
properties.options	CreateUpdateOptions	要为请求应用的选项的键值对。这对应于随请求一起发送的标头。
properties.resource	SqlDatabaseResource	SQL 数据库的标准 JSON 格式
tags	object	标记是描述资源的键值对的列表。在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。最多可以为一个资源提供 15 个标记。每个标记的键不能超过 128 个字符，值不能超过 256 个字符。例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。

SqlDatabaseGetResults

Azure Cosmos DB SQL 数据库。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
location	string	资源所属的资源组的位置。
name	string	ARM 资源的名称。
properties.options	Options
properties.resource	Resource
tags	object	标记是描述资源的键值对的列表。在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。最多可以为一个资源提供 15 个标记。每个标记的键不能超过 128 个字符，值不能超过 256 个字符。例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。

SqlDatabaseResource

Cosmos DB SQL 数据库资源对象

名称	类型	默认值	说明
createMode	CreateMode	Default	用于指示资源创建模式的枚举。
id	string		Cosmos DB SQL 数据库的名称
restoreParameters	ResourceRestoreParameters		指示有关还原的信息的参数

Sql Resources - Create Update Sql Database

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

CosmosDBSqlDatabaseCreateUpdate

Sample Request

Sample Response

定义

AutoscaleSettings

CreateMode

CreateUpdateOptions

Options

Resource

ResourceRestoreParameters

SqlDatabaseCreateUpdateParameters

SqlDatabaseGetResults

SqlDatabaseResource

其他资源