Edit

CreateMigrationRequest interface

Package:
azure-devops-extension-api

Request to create an Enterprise Live Migration.

Properties

agentPoolName

Optional name of the agent pool to run the migration pipeline. When not specified, the pool is determined by region.
configOptions

Optional configuration options for the migration. See ElmConfigOptions.
gitHubUserToken

GitHub token (Device Flow or PAT with read:org scope) proving the identity of the migration owner.
pipelineServiceConnectionId

Optional. The ID of a GitHub Enterprise service connection to use for pipeline rewiring. May be supplied at create time or attached later via PUT /pipelines. When EnableAutoDiscoverPipelines is opted in but no connection is attached, auto-discovery and clone-definition creation no-op during sync, and cutover is blocked by the cutover-readiness check until a connection is attached.
scheduledCutoverDate

The UTC date/time representing when the cutover is to occur.
serviceEndpointId

Optional. ID of a GitHub Enterprise Server-typed service connection whose PAT has ELM API access on the target GHES instance.
skipValidation

Optional. The set of pre-migration validation policies to skip.
targetOwnerUserId

The GitHub login of the migration owner. Set by the server when GitHubUserToken is provided.
targetRepository

URL identifying the destination respository of migration.
validateOnly

True if the migration should only perform pre-migration validation.

Property Details

agentPoolName

Optional name of the agent pool to run the migration pipeline. When not specified, the pool is determined by region.

agentPoolName: string

Property Value

string

configOptions

Optional configuration options for the migration. See ElmConfigOptions.

configOptions: ElmConfigOptions

Property Value

ElmConfigOptions

gitHubUserToken

GitHub token (Device Flow or PAT with read:org scope) proving the identity of the migration owner.

gitHubUserToken: string

Property Value

string

pipelineServiceConnectionId

Optional. The ID of a GitHub Enterprise service connection to use for pipeline rewiring. May be supplied at create time or attached later via PUT /pipelines. When EnableAutoDiscoverPipelines is opted in but no connection is attached, auto-discovery and clone-definition creation no-op during sync, and cutover is blocked by the cutover-readiness check until a connection is attached.

pipelineServiceConnectionId: string

Property Value

string

scheduledCutoverDate

The UTC date/time representing when the cutover is to occur.

scheduledCutoverDate: Date

Property Value

Date

serviceEndpointId

Optional. ID of a GitHub Enterprise Server-typed service connection whose PAT has ELM API access on the target GHES instance.

serviceEndpointId: string

Property Value

string

skipValidation

Optional. The set of pre-migration validation policies to skip.

skipValidation: SkipValidationPolicy

Property Value

SkipValidationPolicy

targetOwnerUserId

The GitHub login of the migration owner. Set by the server when GitHubUserToken is provided.

targetOwnerUserId: string

Property Value

string

targetRepository

URL identifying the destination respository of migration.

targetRepository: string

Property Value

string

validateOnly

True if the migration should only perform pre-migration validation.

validateOnly: boolean

Property Value

boolean