Get-AzImportExport

Module:

Az.ImportExport Module

Gets information about an existing job.

Syntax

List (Default)

Get-AzImportExport
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int64>]
    [-AcceptLanguage <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzImportExport
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-AcceptLanguage <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1

Get-AzImportExport
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int64>]
    [-AcceptLanguage <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzImportExport
    -InputObject <IImportExportIdentity>
    [-AcceptLanguage <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets information about an existing job.

Examples

Example 1: Get ImportExport job with default context

Get-AzImportExport

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet gets ImportExport job with default context.

Example 2: Get ImportExport job by resource group and job name

Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet gets ImportExport job by resource group and job name.

Example 3: Lists all the ImportExport jobs in specified resource group

Get-AzImportExport -ResourceGroupName ImportTestRG

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet lists all the ImportExport jobs in specified resource group.

Example 4: Get ImportExport job by identity

$Id = "/subscriptions/<SubscriptionId>/resourceGroups/ImportTestRG/providers/Microsoft.ImportExport/jobs/test-job"
Get-AzImportExport -InputObject $Id

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet lists gets ImportExport job by identity.

Parameters

-AcceptLanguage

Specifies the preferred language for the response.

Parameter properties

Type:	String
Default value:	None
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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

-Filter

Can be used to restrict the results to certain conditions.

Parameter properties

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

Parameter sets

List

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

List1

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

-InputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentity

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

-Name

The name of the import/export job.

Parameter properties

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

Parameter sets

Get

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

-ResourceGroupName

The resource group name uniquely identifies the resource group within the user subscription.

Parameter properties

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

Parameter sets

Get

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

List1

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

-SubscriptionId

The subscription ID for the Azure user.

Parameter properties

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

Parameter sets

List

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

Get

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

List1

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

-Top

An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.

Parameter properties

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

Parameter sets

List

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

List1

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

IImportExportIdentity

Outputs

IJobResponse