Get-AzMigrateLocalJob

Module:

Az.Migrate Module

Retrieves the status of an Azure Migrate job.

Syntax

ListByName (Default)

Get-AzMigrateLocalJob
    -ResourceGroupName <String>
    -ProjectName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetByName

Get-AzMigrateLocalJob
    -ResourceGroupName <String>
    -ProjectName <String>
    -Name <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetById

Get-AzMigrateLocalJob
    -ID <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetByInputObject

Get-AzMigrateLocalJob
    -InputObject <IMigrateIdentity>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ListById

Get-AzMigrateLocalJob
    -ResourceGroupID <String>
    -ProjectID <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

The Get-AzMigrateLocalJob cmdlet retrieves the status of an Azure Migrate job.

Examples

Example 1: Get by job Id

Get-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a"

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {Cancel}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
DisplayName                        : Delete protected item
EndTime                            :
Error                              : {}
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a
Name                               : 0203aa1b-1dff-4653-89a9-b90a76d1601a
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001
ObjectInternalId                   : 13436868-1f4c-5d4e-a252-c666179bf4df
ObjectInternalName                 : testmachine1
ObjectName                         : testsite-0000-0000-00000001
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/14/2023 7:09:10 PM
State                              : Started
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               : {Prerequisite check, Deleting protected item}
Type                               : Microsoft.DataReplication/replicationVaults/jobs

Retrieves a job by its Id.

Example 2: Get by job name

Get-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj" -Name "0203aa1b-1dff-4653-89a9-b90a76d1601a"

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {Cancel}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
DisplayName                        : Delete protected item
EndTime                            :
Error                              : {}
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a
Name                               : 0203aa1b-1dff-4653-89a9-b90a76d1601a
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001
ObjectInternalId                   : 13436868-1f4c-5d4e-a252-c666179bf4df
ObjectInternalName                 : testmachine1
ObjectName                         : testsite-0000-0000-00000001
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/14/2023 7:09:10 PM
State                              : Started
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               : {Prerequisite check, Deleting protected item}
Type                               : Microsoft.DataReplication/replicationVaults/jobs

Retrieves a job by its name.

Example 3: Get by job input object

$InputObject = Get-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a"

Get-AzMigrateLocalJob -InputObject $InputObject

$InputObject | Get-AzMigrateLocalJob

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {Cancel}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
DisplayName                        : Delete protected item
EndTime                            :
Error                              : {}
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a
Name                               : 0203aa1b-1dff-4653-89a9-b90a76d1601a
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001
ObjectInternalId                   : 13436868-1f4c-5d4e-a252-c666179bf4df
ObjectInternalName                 : testmachine1
ObjectName                         : testsite-0000-0000-00000001
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/14/2023 7:09:10 PM
State                              : Started
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               : {Prerequisite check, Deleting protected item}
Type                               : Microsoft.DataReplication/replicationVaults/jobs

Retrieves a job by the job itself as an input object.

Example 4: List by resource group Id and project Id.

Get-AzMigrateLocalJob -ResourceGroupID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg" -ProjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.Migrate/MigrateProjects/testproj"

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {Cancel}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
DisplayName                        : Delete protected item
EndTime                            :
Error                              : {}
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a
Name                               : 0203aa1b-1dff-4653-89a9-b90a76d1601a
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001
ObjectInternalId                   : 13436868-1f4c-5d4e-a252-c666179bf4df
ObjectInternalName                 : testmachine1
ObjectName                         : testsite-0000-0000-00000001
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/14/2023 7:09:10 PM
State                              : Started
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               : {Prerequisite check, Deleting protected item}
Type                               : Microsoft.DataReplication/replicationVaults/jobs

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
CustomPropertyInstanceType         :
DisplayName                        : Planned failover
EndTime                            : 8/11/2023 10:09:18 PM
Error                              :
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed
Name                               : f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000000/plannedFailover
ObjectInternalId                   : 4ef231a3-0774-5e44-8317-bed903d297a2
ObjectInternalName                 : testmachine2
ObjectName                         : testsite-0000-0000-00000000
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/11/2023 9:53:48 PM
State                              : Succeeded
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               :
Type                               : Microsoft.DataReplication/replicationVaults/jobs

Retrieves all the jobs from a project in some resource group by Ids.

Example 5: List by resource group name and project name.

Get-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj"

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {Cancel}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
DisplayName                        : Delete protected item
EndTime                            :
Error                              : {}
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a
Name                               : 0203aa1b-1dff-4653-89a9-b90a76d1601a
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001
ObjectInternalId                   : 13436868-1f4c-5d4e-a252-c666179bf4df
ObjectInternalName                 : testmachine1
ObjectName                         : testsite-0000-0000-00000001
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/14/2023 7:09:10 PM
State                              : Started
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               : {Prerequisite check, Deleting protected item}
Type                               : Microsoft.DataReplication/replicationVaults/jobs

ActivityId                         :  ActivityId: 00000000-0000-0000-0000-000000000000
AllowedAction                      : {}
CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails
CustomPropertyInstanceType         :
DisplayName                        : Planned failover
EndTime                            : 8/11/2023 10:09:18 PM
Error                              :
Id                                 : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/jobs/f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed
Name                               : f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed
ObjectId                           : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication
                                     /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000000/plannedFailover
ObjectInternalId                   : 4ef231a3-0774-5e44-8317-bed903d297a2
ObjectInternalName                 : testmachine2
ObjectName                         : testsite-0000-0000-00000000
ObjectType                         : ProtectedItem
ReplicationProviderId              : 0a870516-56c7-4460-998c-f267bd579f16
SourceFabricProviderId             : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7
StartTime                          : 8/11/2023 9:53:48 PM
State                              : Succeeded
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           :
SystemDataLastModifiedBy           :
SystemDataLastModifiedByType       :
TargetFabricProviderId             : 22f00372-a1b7-467f-87ce-d95e17a6e7c7
Task                               :
Type                               : Microsoft.DataReplication/replicationVaults/jobs

Retrieves all the jobs from a project in some resource group by names.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ID

Specifies the job id for which the details needs to be retrieved.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Specifies the job object of the replicating server. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	IMigrateIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByInputObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Job identifier

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProjectID

Specifies the Azure Migrate Project in which servers are replicating.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ListById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProjectName

The name of the migrate project.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ListByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupID

Specifies the Resource Group of the Azure Migrate Project in the current subscription.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ListById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The name of the resource group where the recovery services vault is present.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ListByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

Azure Subscription ID.

Parameter properties

Type:	String
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IMigrateIdentity

Outputs

IJobModel