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

Projects - Update

Service:

Data Migration

API Version:

2022-03-30-preview

更新项目
项目资源是表示存储迁移项目的嵌套资源。 PATCH 方法更新现有项目。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}?api-version=2022-03-30-preview

URI 参数

名称	在	必需	类型	说明
groupName	path	True	string	资源组的名称
projectName	path	True	string	项目的名称
serviceName	path	True	string	服务名称
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	API 的版本

请求正文

名称	必需	类型	说明
properties.sourcePlatform	True	ProjectSourcePlatform	项目的源平台
properties.targetPlatform	True	ProjectTargetPlatform	项目的目标平台
etag		string	HTTP 强实体标记值。 如果已提交，则会忽略这一点。
location		string
properties.azureAuthenticationInfo		AzureActiveDirectoryApp	定义用于连接到目标 Azure 资源的 Azure Active Directory 应用程序信息的字段
properties.databasesInfo		DatabaseInfo[]	DatabaseInfo 列表
properties.sourceConnectionInfo		ConnectionInfo: SqlConnectionInfo MySqlConnectionInfo OracleConnectionInfo PostgreSqlConnectionInfo MiSqlConnectionInfo	有关连接到源的信息
properties.targetConnectionInfo		ConnectionInfo: SqlConnectionInfo MySqlConnectionInfo OracleConnectionInfo PostgreSqlConnectionInfo MiSqlConnectionInfo	连接到目标的信息
tags		object

响应

名称	类型	说明
200 OK	Project	已更新项目资源
Other Status Codes	ApiError	错误

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Projects_Update

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject?api-version=2022-03-30-preview

{
  "location": "southcentralus",
  "properties": {
    "sourcePlatform": "SQL",
    "targetPlatform": "SQLDB"
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.datamigration import DataMigrationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datamigration
# USAGE
    python projects_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 = DataMigrationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="fc04246f-04c5-437e-ac5e-206a19e7193f",
    )

    response = client.projects.update(
        group_name="DmsSdkRg",
        service_name="DmsSdkService",
        project_name="DmsSdkProject",
        parameters={"location": "southcentralus", "properties": {"sourcePlatform": "SQL", "targetPlatform": "SQLDB"}},
    )
    print(response)


# x-ms-original-file: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Projects_Update.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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataMigration;
using Azure.ResourceManager.DataMigration.Models;

// Generated from example definition: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Projects_Update.json
// this example is just showing the usage of "Projects_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProjectResource created on azure
// for more information of creating ProjectResource, please refer to the document of ProjectResource
string subscriptionId = "fc04246f-04c5-437e-ac5e-206a19e7193f";
string groupName = "DmsSdkRg";
string serviceName = "DmsSdkService";
string projectName = "DmsSdkProject";
ResourceIdentifier projectResourceId = ProjectResource.CreateResourceIdentifier(subscriptionId, groupName, serviceName, projectName);
ProjectResource project = client.GetProjectResource(projectResourceId);

// invoke the operation
ProjectData data = new ProjectData(new AzureLocation("southcentralus"))
{
    SourcePlatform = ProjectSourcePlatform.Sql,
    TargetPlatform = ProjectTargetPlatform.SqlDB,
};
ProjectResource result = await project.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ProjectData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "properties": {
    "sourcePlatform": "SQL",
    "targetPlatform": "SQLDB",
    "creationTime": "2017-11-03T02:14:54.2458282-07:00",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject",
  "location": "southcentralus",
  "name": "DmsSdkProject",
  "type": "Microsoft.DataMigration/services/projects"
}

定义

名称	说明
ApiError	错误信息。
AuthenticationType	连接时可能的身份验证类型的枚举
AzureActiveDirectoryApp	Azure Active Directory 应用程序
createdByType
DatabaseInfo	项目数据库详细信息
MiSqlConnectionInfo	创建与Azure SQL数据库托管实例的连接所需的属性
MySqlConnectionInfo	有关连接到 MySQL 服务器的信息
ODataError	OData 格式的错误信息。
OracleConnectionInfo	有关连接到 Oracle 服务器的信息
PostgreSqlConnectionInfo	有关连接到 PostgreSQL 服务器的信息
Project	项目资源
ProjectProvisioningState	项目的预配状态
ProjectSourcePlatform	项目的源平台
ProjectTargetPlatform	项目的目标平台
SqlConnectionInfo	有关连接到 SQL 数据库服务器的信息
SqlSourcePlatform	用于连接的服务器平台类型
SystemData

ApiError

错误信息。

名称	类型	说明
error	ODataError	OData 格式的错误信息
systemData	SystemData	与资源的创建和上次修改相关的元数据。

AuthenticationType

连接时可能的身份验证类型的枚举

名称	类型	说明
ActiveDirectoryIntegrated	string
ActiveDirectoryPassword	string
None	string
SqlAuthentication	string
WindowsAuthentication	string

AzureActiveDirectoryApp

Azure Active Directory 应用程序

名称	类型	说明
appKey	string	用于向 Azure Active Directory 应用程序进行身份验证的密钥
applicationId	string	Azure Active Directory 应用程序的应用程序 ID
ignoreAzurePermissions	boolean	忽略在 AAD 应用上检查 Azure 权限
tenantId	string	客户的租户 ID

createdByType

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseInfo

项目数据库详细信息

名称	类型	说明
sourceDatabaseName	string	数据库的名称

MiSqlConnectionInfo

创建与Azure SQL数据库托管实例的连接所需的属性

名称	类型	说明
managedInstanceResourceId	string	Azure SQL数据库托管实例的资源 ID
password	string	密码凭据。
type	string: MiSqlConnectionInfo	连接信息的类型
userName	string	用户名

MySqlConnectionInfo

有关连接到 MySQL 服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		数据源
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
port	integer		服务器的端口
serverName	string		服务器的名称
type	string: MySqlConnectionInfo		连接信息的类型
userName	string		用户名

ODataError

OData 格式的错误信息。

名称	类型	说明
code	string	错误的计算机可读说明，例如“InvalidRequest”或“InternalServerError”
details	ODataError[]	导致此错误的内部错误
message	string	错误的可读说明

OracleConnectionInfo

有关连接到 Oracle 服务器的信息

名称	类型	说明
authentication	AuthenticationType	用于连接的身份验证类型
dataSource	string	EZConnect 或 TNSName 连接字符串。
password	string	密码凭据。
port	integer	服务器的端口
serverName	string	服务器的名称
serverVersion	string	服务器版本
type	string: OracleConnectionInfo	连接信息的类型
userName	string	用户名

PostgreSqlConnectionInfo

有关连接到 PostgreSQL 服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		数据源
databaseName	string		数据库的名称
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
port	integer		服务器的端口
serverBrandVersion	string		服务器品牌版本
serverName	string		服务器的名称
serverVersion	string		服务器版本
trustServerCertificate	boolean	False	是否信任服务器证书
type	string: PostgreSqlConnectionInfo		连接信息的类型
userName	string		用户名

Project

项目资源

名称	类型	说明
etag	string	HTTP 强实体标记值。 如果已提交，则会忽略这一点。
id	string
location	string
name	string
properties.azureAuthenticationInfo	AzureActiveDirectoryApp	定义用于连接到目标 Azure 资源的 Azure Active Directory 应用程序信息的字段
properties.creationTime	string	UTC 创建项目的日期和时间
properties.databasesInfo	DatabaseInfo[]	DatabaseInfo 列表
properties.provisioningState	ProjectProvisioningState	项目的预配状态
properties.sourceConnectionInfo	ConnectionInfo: MiSqlConnectionInfo MySqlConnectionInfo OracleConnectionInfo PostgreSqlConnectionInfo SqlConnectionInfo	有关连接到源的信息
properties.sourcePlatform	ProjectSourcePlatform	项目的源平台
properties.targetConnectionInfo	ConnectionInfo: MiSqlConnectionInfo MySqlConnectionInfo OracleConnectionInfo PostgreSqlConnectionInfo SqlConnectionInfo	连接到目标的信息
properties.targetPlatform	ProjectTargetPlatform	项目的目标平台
systemData	SystemData	与资源的创建和上次修改相关的元数据。
tags	object
type	string

ProjectProvisioningState

项目的预配状态

名称	类型	说明
Deleting	string
Succeeded	string

ProjectSourcePlatform

项目的源平台

名称	类型	说明
MongoDb	string
MySQL	string
PostgreSql	string
SQL	string
Unknown	string

ProjectTargetPlatform

项目的目标平台

名称	类型	说明
AzureDbForMySql	string
AzureDbForPostgreSql	string
MongoDb	string
SQLDB	string
SQLMI	string
Unknown	string

SqlConnectionInfo

有关连接到 SQL 数据库服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		格式为 Protocol：MachineName\SQLServerInstanceName，PortNumber 的数据源
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
platform	SqlSourcePlatform		用于连接的服务器平台类型
port	integer		服务器的端口
resourceId	string		表示由 Azure 资源提供程序表示的 HTTP 资源的 ID。
serverBrandVersion	string		服务器品牌版本
serverName	string		服务器的名称
serverVersion	string		服务器版本
trustServerCertificate	boolean	False	是否信任服务器证书
type	string: SqlConnectionInfo		连接信息的类型
userName	string		用户名

SqlSourcePlatform

用于连接的服务器平台类型

名称	类型	说明
SqlOnPrem	string

SystemData

名称	类型	说明
createdAt	string
createdBy	string
createdByType	createdByType
lastModifiedAt	string
lastModifiedBy	string
lastModifiedByType	createdByType