Edit

Get-AzImportExport

  • Reference
Module:
Az.ImportExport

Gets information about an existing job.

Syntax

Get-AzImportExport
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-Top <Int64>]
   [-AcceptLanguage <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzImportExport
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-AcceptLanguage <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzImportExport
   -InputObject <IImportExportIdentity>
   [-AcceptLanguage <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzImportExport
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-Top <Int64>]
   [-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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Can be used to restrict the results to certain conditions.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IImportExportIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the import/export job.

Type:String
Aliases:JobName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The subscription ID for the Azure user.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

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

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IImportExportIdentity

Outputs

IJobResponse

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IImportExportIdentity>: Identity Parameter

  • [Id <String>]: Resource identity path
  • [JobName <String>]: The name of the import/export job.
  • [LocationName <String>]: The name of the location. For example, West US or westus.
  • [ResourceGroupName <String>]: The resource group name uniquely identifies the resource group within the user subscription.
  • [SubscriptionId <String>]: The subscription ID for the Azure user.