Get-AzImage
Gets the properties of an image.
Syntax
Default (Default)
Get-AzImage
[[-ResourceGroupName] <String>]
[[-ImageName] <String>]
[[-Expand] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzImage cmdlet gets the properties of an image.
Examples
Example 1
Get-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01'
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image01
Name : Image01
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
This command gets the properties of the image named 'Image01' in the resource group 'ResourceGroup01'.
Example 2
Get-AzImage -ResourceGroupName 'ResourceGroup01'
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image01
Name : Image01
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image02
Name : Image02
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
This command gets the properties of all images in the resource group 'ResourceGroup01'.
Example 3
Get-AzImage
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image01
Name : Image01
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image02
Name : Image02
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
ResourceGroupName : ResourceGroup02
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/prov
iders/Microsoft.Compute/images/Image03
Name : Image03
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
This command gets the properties of all images under the subscription.
Example 4
Get-AzImage -Name "Image*"
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image01
Name : Image01
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
ResourceGroupName : ResourceGroup01
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov
iders/Microsoft.Compute/images/Image02
Name : Image02
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
ResourceGroupName : ResourceGroup02
SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource
StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/prov
iders/Microsoft.Compute/images/Image03
Name : Image03
Type : Microsoft.Compute/images
Location : eastus2
Tags : {}
This command gets the properties of all images under the subscription that start with "Image".
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, 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 |
-Expand
Specifies the expand expression query.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ImageName
Specifies the name of an image.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
