1. Packages
  2. Azure Native v2
  3. API Docs
  4. datamigration
  5. getProject
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.datamigration.getProject

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project. Azure REST API version: 2021-06-30.

Other available API versions: 2021-10-30-preview, 2022-03-30-preview, 2023-07-15-preview.

Using getProject

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
Copy
def get_project(group_name: Optional[str] = None,
                project_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(group_name: Optional[pulumi.Input[str]] = None,
                project_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
Copy
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
Copy

> Note: This function is named LookupProject in the Go SDK.

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:datamigration:getProject
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group
project_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the project
service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service

getProject Result

The following output properties are available:

CreationTime string
UTC Date and time when project was created
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The project's provisioning state
SourcePlatform string
Source platform for the project
SystemData Pulumi.AzureNative.DataMigration.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TargetPlatform string
Target platform for the project
Type string
Resource type.
DatabasesInfo List<Pulumi.AzureNative.DataMigration.Outputs.DatabaseInfoResponse>
List of DatabaseInfo
SourceConnectionInfo Pulumi.AzureNative.DataMigration.Outputs.MiSqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.MongoDbConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.MySqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.OracleConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.PostgreSqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.SqlConnectionInfoResponse
Information for connecting to source
Tags Dictionary<string, string>
Resource tags.
TargetConnectionInfo Pulumi.AzureNative.DataMigration.Outputs.MiSqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.MongoDbConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.MySqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.OracleConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.PostgreSqlConnectionInfoResponse | Pulumi.AzureNative.DataMigration.Outputs.SqlConnectionInfoResponse
Information for connecting to target
CreationTime string
UTC Date and time when project was created
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The project's provisioning state
SourcePlatform string
Source platform for the project
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TargetPlatform string
Target platform for the project
Type string
Resource type.
DatabasesInfo []DatabaseInfoResponse
List of DatabaseInfo
SourceConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to source
Tags map[string]string
Resource tags.
TargetConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to target
creationTime String
UTC Date and time when project was created
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The project's provisioning state
sourcePlatform String
Source platform for the project
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
targetPlatform String
Target platform for the project
type String
Resource type.
databasesInfo List<DatabaseInfoResponse>
List of DatabaseInfo
sourceConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to source
tags Map<String,String>
Resource tags.
targetConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to target
creationTime string
UTC Date and time when project was created
id string
Resource ID.
location string
Resource location.
name string
Resource name.
provisioningState string
The project's provisioning state
sourcePlatform string
Source platform for the project
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
targetPlatform string
Target platform for the project
type string
Resource type.
databasesInfo DatabaseInfoResponse[]
List of DatabaseInfo
sourceConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to source
tags {[key: string]: string}
Resource tags.
targetConnectionInfo MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to target
creation_time str
UTC Date and time when project was created
id str
Resource ID.
location str
Resource location.
name str
Resource name.
provisioning_state str
The project's provisioning state
source_platform str
Source platform for the project
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
target_platform str
Target platform for the project
type str
Resource type.
databases_info Sequence[DatabaseInfoResponse]
List of DatabaseInfo
source_connection_info MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to source
tags Mapping[str, str]
Resource tags.
target_connection_info MiSqlConnectionInfoResponse | MongoDbConnectionInfoResponse | MySqlConnectionInfoResponse | OracleConnectionInfoResponse | PostgreSqlConnectionInfoResponse | SqlConnectionInfoResponse
Information for connecting to target
creationTime String
UTC Date and time when project was created
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The project's provisioning state
sourcePlatform String
Source platform for the project
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
targetPlatform String
Target platform for the project
type String
Resource type.
databasesInfo List<Property Map>
List of DatabaseInfo
sourceConnectionInfo Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
Information for connecting to source
tags Map<String>
Resource tags.
targetConnectionInfo Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
Information for connecting to target

Supporting Types

DatabaseInfoResponse

SourceDatabaseName This property is required. string
Name of the database
SourceDatabaseName This property is required. string
Name of the database
sourceDatabaseName This property is required. String
Name of the database
sourceDatabaseName This property is required. string
Name of the database
source_database_name This property is required. str
Name of the database
sourceDatabaseName This property is required. String
Name of the database

MiSqlConnectionInfoResponse

ManagedInstanceResourceId This property is required. string
Resource id for Azure SQL database Managed instance
Password string
Password credential.
UserName string
User name
ManagedInstanceResourceId This property is required. string
Resource id for Azure SQL database Managed instance
Password string
Password credential.
UserName string
User name
managedInstanceResourceId This property is required. String
Resource id for Azure SQL database Managed instance
password String
Password credential.
userName String
User name
managedInstanceResourceId This property is required. string
Resource id for Azure SQL database Managed instance
password string
Password credential.
userName string
User name
managed_instance_resource_id This property is required. str
Resource id for Azure SQL database Managed instance
password str
Password credential.
user_name str
User name
managedInstanceResourceId This property is required. String
Resource id for Azure SQL database Managed instance
password String
Password credential.
userName String
User name

MongoDbConnectionInfoResponse

ConnectionString This property is required. string
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
Password string
Password credential.
UserName string
User name
ConnectionString This property is required. string
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
Password string
Password credential.
UserName string
User name
connectionString This property is required. String
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
password String
Password credential.
userName String
User name
connectionString This property is required. string
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
password string
Password credential.
userName string
User name
connection_string This property is required. str
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
password str
Password credential.
user_name str
User name
connectionString This property is required. String
A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties
password String
Password credential.
userName String
User name

MySqlConnectionInfoResponse

Port This property is required. int
Port for Server
ServerName This property is required. string
Name of the server
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
UserName string
User name
Port This property is required. int
Port for Server
ServerName This property is required. string
Name of the server
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
UserName string
User name
port This property is required. Integer
Port for Server
serverName This property is required. String
Name of the server
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
userName String
User name
port This property is required. number
Port for Server
serverName This property is required. string
Name of the server
encryptConnection boolean
Whether to encrypt the connection
password string
Password credential.
userName string
User name
port This property is required. int
Port for Server
server_name This property is required. str
Name of the server
encrypt_connection bool
Whether to encrypt the connection
password str
Password credential.
user_name str
User name
port This property is required. Number
Port for Server
serverName This property is required. String
Name of the server
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
userName String
User name

OracleConnectionInfoResponse

DataSource This property is required. string
EZConnect or TNSName connection string.
Password string
Password credential.
UserName string
User name
DataSource This property is required. string
EZConnect or TNSName connection string.
Password string
Password credential.
UserName string
User name
dataSource This property is required. String
EZConnect or TNSName connection string.
password String
Password credential.
userName String
User name
dataSource This property is required. string
EZConnect or TNSName connection string.
password string
Password credential.
userName string
User name
data_source This property is required. str
EZConnect or TNSName connection string.
password str
Password credential.
user_name str
User name
dataSource This property is required. String
EZConnect or TNSName connection string.
password String
Password credential.
userName String
User name

PostgreSqlConnectionInfoResponse

Port This property is required. int
Port for Server
ServerName This property is required. string
Name of the server
DatabaseName string
Name of the database
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
TrustServerCertificate bool
Whether to trust the server certificate
UserName string
User name
Port This property is required. int
Port for Server
ServerName This property is required. string
Name of the server
DatabaseName string
Name of the database
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
TrustServerCertificate bool
Whether to trust the server certificate
UserName string
User name
port This property is required. Integer
Port for Server
serverName This property is required. String
Name of the server
databaseName String
Name of the database
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
trustServerCertificate Boolean
Whether to trust the server certificate
userName String
User name
port This property is required. number
Port for Server
serverName This property is required. string
Name of the server
databaseName string
Name of the database
encryptConnection boolean
Whether to encrypt the connection
password string
Password credential.
trustServerCertificate boolean
Whether to trust the server certificate
userName string
User name
port This property is required. int
Port for Server
server_name This property is required. str
Name of the server
database_name str
Name of the database
encrypt_connection bool
Whether to encrypt the connection
password str
Password credential.
trust_server_certificate bool
Whether to trust the server certificate
user_name str
User name
port This property is required. Number
Port for Server
serverName This property is required. String
Name of the server
databaseName String
Name of the database
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
trustServerCertificate Boolean
Whether to trust the server certificate
userName String
User name

SqlConnectionInfoResponse

DataSource This property is required. string
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
AdditionalSettings string
Additional connection settings
Authentication string
Authentication type to use for connection
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
Platform string
Server platform type for connection
TrustServerCertificate bool
Whether to trust the server certificate
UserName string
User name
DataSource This property is required. string
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
AdditionalSettings string
Additional connection settings
Authentication string
Authentication type to use for connection
EncryptConnection bool
Whether to encrypt the connection
Password string
Password credential.
Platform string
Server platform type for connection
TrustServerCertificate bool
Whether to trust the server certificate
UserName string
User name
dataSource This property is required. String
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
additionalSettings String
Additional connection settings
authentication String
Authentication type to use for connection
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
platform String
Server platform type for connection
trustServerCertificate Boolean
Whether to trust the server certificate
userName String
User name
dataSource This property is required. string
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
additionalSettings string
Additional connection settings
authentication string
Authentication type to use for connection
encryptConnection boolean
Whether to encrypt the connection
password string
Password credential.
platform string
Server platform type for connection
trustServerCertificate boolean
Whether to trust the server certificate
userName string
User name
data_source This property is required. str
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
additional_settings str
Additional connection settings
authentication str
Authentication type to use for connection
encrypt_connection bool
Whether to encrypt the connection
password str
Password credential.
platform str
Server platform type for connection
trust_server_certificate bool
Whether to trust the server certificate
user_name str
User name
dataSource This property is required. String
Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber
additionalSettings String
Additional connection settings
authentication String
Authentication type to use for connection
encryptConnection Boolean
Whether to encrypt the connection
password String
Password credential.
platform String
Server platform type for connection
trustServerCertificate Boolean
Whether to trust the server certificate
userName String
User name

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi