Edit

Share via

Get-AzDevCenterUserDevBoxSnapshot

Module:
Az.DevCenter Module

Gets a snapshot by snapshot id.

Syntax

List (Default) 

Get-AzDevCenterUserDevBoxSnapshot
    -Endpoint <String>
    -DevBoxName <String>
    -ProjectName <String>
    [-UserId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzDevCenterUserDevBoxSnapshot
    -Endpoint <String>
    -DevBoxName <String>
    -ProjectName <String>
    -SnapshotId <String>
    [-UserId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzDevCenterUserDevBoxSnapshot
    -Endpoint <String>
    -InputObject <IDevCenterdataIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetByDevCenter 

Get-AzDevCenterUserDevBoxSnapshot
    -DevCenterName <String>
    -DevBoxName <String>
    -ProjectName <String>
    -SnapshotId <String>
    [-UserId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ListByDevCenter 

Get-AzDevCenterUserDevBoxSnapshot
    -DevCenterName <String>
    -DevBoxName <String>
    -ProjectName <String>
    [-UserId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityByDevCenter 

Get-AzDevCenterUserDevBoxSnapshot
    -DevCenterName <String>
    -InputObject <IDevCenterdataIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets a snapshot by snapshot id.

Examples

Example 1: Get all snapshots for a Dev Box by endpoint and user ID

Get-AzDevCenterUserDevBoxSnapshot `
  -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" `
  -ProjectName "DevProject" `
  -DevBoxName "myDevBox" `
  -UserId "786a823c-8037-48ab-89b8-8599901e67d0"

This command gets all snapshots for the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0" using the endpoint.

Example 2: Get a specific snapshot for a Dev Box by endpoint and snapshot ID

Get-AzDevCenterUserDevBoxSnapshot `
  -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" `
  -ProjectName "DevProject" `
  -DevBoxName "myDevBox" `
  -UserId "786a823c-8037-48ab-89b8-8599901e67d0" `
  -SnapshotId "snapshot-1234"

This command gets the snapshot with ID "snapshot-1234" for the dev box "myDevBox" assigned to the specified user using the endpoint.

Example 3: Get all snapshots for a Dev Box by dev center and current user

Get-AzDevCenterUserDevBoxSnapshot `
  -DevCenterName "ContosoDevCenter" `
  -ProjectName "DevProject" `
  -DevBoxName "myDevBox" `
  -UserId "me"

This command gets all snapshots for the dev box "myDevBox" assigned to the current signed-in user using the dev center name.

Example 4: Get a specific snapshot for a Dev Box by dev center and snapshot ID

Get-AzDevCenterUserDevBoxSnapshot `
  -DevCenterName "ContosoDevCenter" `
  -ProjectName "DevProject" `
  -DevBoxName "myDevBox" `
  -UserId "me" `
  -SnapshotId "snapshot-1234"

This command gets the snapshot with ID "snapshot-1234" for the dev box "myDevBox" assigned to the current signed-in user using the dev center name.

Example 5: Get a snapshot using InputObject and endpoint

$snapshotInput = @{
    DevBoxName = "myDevBox"
    UserId = "786a823c-8037-48ab-89b8-8599901e67d0"
    ProjectName = "DevProject"
    SnapshotId = "snapshot-1234"
}
Get-AzDevCenterUserDevBoxSnapshot `
  -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" `
  -InputObject $snapshotInput

This command gets the snapshot with ID "snapshot-1234" for the dev box "myDevBox" using the endpoint and an identity object.

Parameters

-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

-DevBoxName

Display name for the Dev Box.

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DevCenterName

The DevCenter upon which to execute operations.

Parameter properties

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

Parameter sets

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

-Endpoint

The DevCenter-specific URI to operate on.

Parameter properties

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

Parameter sets

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

-InputObject

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

Parameter properties

Type:IDevCenterdataIdentity
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
GetViaIdentityByDevCenter
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ProjectName

Name of the project.

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SnapshotId

The id of the snapshot. Should be treated as opaque string.

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
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Parameter properties

Type:String
Default value:me
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
GetByDevCenter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListByDevCenter
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

IDevCenterdataIdentity

Outputs

IDevBoxSnapshot