Projects - List

Ссылка

Service:: Data Migration

API Version:: 2022-01-30-preview

Получение проектов в службе
Ресурс проекта — это вложенный ресурс, представляющий сохраненный проект миграции. Этот метод возвращает список проектов, принадлежащих ресурсу службы.

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

Параметры URI

Name	In	Required	Type	Description
groupName	path	True	string	Имя группы ресурсов
serviceName	path	True	string	Имя службы
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API

Ответы

Name	Type	Description
200 OK	ProjectList	Список проектов
Other Status Codes	ApiError	Ошибка

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Projects_List

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "sourcePlatform": "SQL",
        "targetPlatform": "SQLDB",
        "creationTime": "2017-11-14T01:29:56.3049263+00:00",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/project1",
      "location": "southcentralus",
      "name": "project1",
      "type": "Microsoft.DataMigration/services/projects"
    },
    {
      "properties": {
        "sourcePlatform": "SQL",
        "targetPlatform": "SQLDB",
        "creationTime": "2017-11-14T01:30:05.6185148+00:00",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/project2",
      "location": "southcentralus",
      "name": "project2",
      "type": "Microsoft.DataMigration/services/projects"
    }
  ]
}

Определения

ApiError	Сведения об ошибке.
AuthenticationType	Перечисление возможных типов проверки подлинности при подключении
AzureActiveDirectoryApp	приложение Azure Active Directory
createdByType
DatabaseInfo	сведения о базе данных Project
MiSqlConnectionInfo	Свойства, необходимые для создания подключения к управляемому экземпляру базы данных Azure SQL
MySqlConnectionInfo	Сведения о подключении к серверу MySQL
ODataError	Сведения об ошибке в формате OData.
OracleConnectionInfo	Сведения о подключении к серверу Oracle
PostgreSqlConnectionInfo	Сведения о подключении к серверу PostgreSQL
Project	Ресурс проекта
ProjectList	Страница OData ресурсов проекта
ProjectProvisioningState	Состояние подготовки проекта
ProjectSourcePlatform	Исходная платформа проекта
ProjectTargetPlatform	Целевая платформа проекта
SqlConnectionInfo	Сведения о подключении к серверу базы данных SQL
SqlSourcePlatform	Тип платформы сервера для подключения
SystemData

ApiError

Сведения об ошибке.

Name	Type	Description
error	ODataError	Сведения об ошибке в формате OData
systemData	SystemData	Метаданные, относящиеся к созданию и последнему модификации ресурса.

AuthenticationType

Перечисление возможных типов проверки подлинности при подключении

Name	Type	Description
ActiveDirectoryIntegrated	string
ActiveDirectoryPassword	string
None	string
SqlAuthentication	string
WindowsAuthentication	string

AzureActiveDirectoryApp

приложение Azure Active Directory

Name	Type	Description
appKey	string	Ключ, используемый для проверки подлинности в приложении Azure Active Directory
applicationId	string	Идентификатор приложения Azure Active Directory
ignoreAzurePermissions	boolean	Пропуск проверки разрешений Azure в приложении AAD
tenantId	string	Идентификатор клиента

createdByType

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseInfo

сведения о базе данных Project

Name	Type	Description
sourceDatabaseName	string	Имя базы данных.

MiSqlConnectionInfo

Свойства, необходимые для создания подключения к управляемому экземпляру базы данных Azure SQL

Name	Type	Description
managedInstanceResourceId	string	Идентификатор ресурса для управляемого экземпляра базы данных Azure SQL
password	string	Учетные данные пароля.
type	string: MiSqlConnectionInfo	Тип сведений о подключении
userName	string	Имя пользователя

MySqlConnectionInfo

Сведения о подключении к серверу MySQL

Name	Type	Default Value	Description
authentication	AuthenticationType		Тип проверки подлинности, используемый для подключения
dataSource	string		Источник данных
encryptConnection	boolean	True	Следует ли шифровать подключение
password	string		Учетные данные пароля.
port	integer		Порт для сервера
serverName	string		Имя сервера
type	string: MySqlConnectionInfo		Тип сведений о подключении
userName	string		Имя пользователя

ODataError

Сведения об ошибке в формате OData.

Name	Type	Description
code	string	Машинное описание ошибки, например InvalidRequest или InternalServerError.
details	ODataError[]	Внутренние ошибки, вызвавшие эту ошибку
message	string	Понятное описание ошибки

OracleConnectionInfo

Сведения о подключении к серверу Oracle

Name	Type	Description
dataSource	string	Строка подключения EZConnect или TNSName.
password	string	Учетные данные пароля.
type	string: OracleConnectionInfo	Тип сведений о подключении
userName	string	Имя пользователя

PostgreSqlConnectionInfo

Сведения о подключении к серверу PostgreSQL

Name	Type	Default Value	Description
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

Ресурс проекта

Name	Type	Description
etag	string	Значение тега строгой сущности HTTP. Этот параметр игнорируется при отправке.
id	string
location	string
name	string
properties.azureAuthenticationInfo	AzureActiveDirectoryApp	Поле, определяющее сведения о приложении Azure Active Directory, используемое для подключения к целевому ресурсу Azure
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

ProjectList

Страница OData ресурсов проекта

Name	Type	Description
nextLink	string	URL-адрес для загрузки следующей страницы проектов
value	Project[]	Список проектов

ProjectProvisioningState

Состояние подготовки проекта

Name	Type	Description
Deleting	string
Succeeded	string

ProjectSourcePlatform

Исходная платформа проекта

Name	Type	Description
MongoDb	string
MySQL	string
PostgreSql	string
SQL	string
Unknown	string

ProjectTargetPlatform

Целевая платформа проекта

Name	Type	Description
AzureDbForMySql	string
AzureDbForPostgreSql	string
MongoDb	string
SQLDB	string
SQLMI	string
Unknown	string

SqlConnectionInfo

Сведения о подключении к серверу базы данных SQL

Name	Type	Default Value	Description
additionalSettings	string		Дополнительные параметры подключения
authentication	AuthenticationType		Тип проверки подлинности, используемый для подключения
dataSource	string		Источник данных в формате Protocol:MachineName\SQLServerInstanceName,PortNumber
encryptConnection	boolean	True	Следует ли шифровать подключение
password	string		Учетные данные пароля.
platform	SqlSourcePlatform		Тип платформы сервера для подключения
port	integer		Порт для сервера
resourceId	string		Представляет идентификатор ресурса HTTP, представленного поставщиком ресурсов Azure.
serverBrandVersion	string		версия фирменной символики сервера
serverName	string		имя сервера
serverVersion	string		версия сервера
trustServerCertificate	boolean	False	Указывает, следует ли доверять сертификату сервера
type	string: SqlConnectionInfo		Тип сведений о подключении
userName	string		Имя пользователя

SqlSourcePlatform

Тип платформы сервера для подключения

Name	Type	Description
SqlOnPrem	string

SystemData

Name	Type	Description
createdAt	string
createdBy	string
createdByType	createdByType
lastModifiedAt	string
lastModifiedBy	string
lastModifiedByType	createdByType