Update-AzGalleryInVMAccessControlProfileVersion
Updates a specific version of a gallery inVMAccessControlProfile.
Syntax
Default (Default)
Update-AzGalleryInVMAccessControlProfileVersion
-GalleryInVmAccessControlProfileVersion <PSGalleryInVMAccessControlProfileVersion>
[-TargetLocation <String[]>]
[-ExcludeFromLatest <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzGalleryInVMAccessControlProfileVersion cmdlet updates a specific version of a gallery inVMAccessControlProfile.
The gallery inVMAccessControlVersion to be updated can be passed by providing the PSGalleryInVMAccessControlProfileVersion object retrieved from the Get-AzGalleryInVMAccessControlProfileVersion cmdlet.
Examples
Example 1
$CPversion = Get-AzGalleryInVMAccessControlProfileVersion -ResourceGroupName "myResourceGroup" -GalleryName "myGallery" -GalleryInVMAccessControlProfileName "myProfile" -GalleryInVMAccessControlProfileVersionName "myProfileVersion"
Update-AzGalleryInVMAccessControlProfileVersion -GalleryInVmAccessControlProfileVersion $CPversion -TargetLocation @("West US 2", "West US") -ExcludeFromLatest $true
This example first uses Get-AzGalleryInVMAccessControlProfileVersion to retrieves the specified version of the gallery inVMAccessControlProfile that needs to be updated.
Then it uses Update-AzGalleryInVMAccessControlProfileVersion to update its TargetLocation and excludeFromLatest property.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: cf
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 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
-ExcludeFromLatest
If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-GalleryInVmAccessControlProfileVersion
PSGalleryInVmAccessControlProfileVersion object created from New-AzGalleryInVMAccessControlProfileVersionConfig.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-TargetLocation
The names of the target regions where the Resource Profile version is going to be replicated to. This property is updatable.
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: True
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: wi
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 .
Outputs