Update-AzCustomIpPrefix
Updates a CustomIpPrefix
Syntax
Update-AzCustomIpPrefix
-Name <String>
-ResourceGroupName <String>
[-Commission]
[-Decommission]
[-Provision]
[-Deprovision]
[-NoInternetAdvertise]
[-Cidr <String>]
[-Tag <Hashtable>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzCustomIpPrefix
-InputObject <PSCustomIpPrefix>
[-Commission]
[-Decommission]
[-Provision]
[-Deprovision]
[-NoInternetAdvertise]
[-Cidr <String>]
[-Tag <Hashtable>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzCustomIpPrefix
-ResourceId <String>
[-Commission]
[-Decommission]
[-Provision]
[-Deprovision]
[-NoInternetAdvertise]
[-Cidr <String>]
[-Tag <Hashtable>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzCustomIpPrefix cmdlet allows the user to provision, commission, deprovision or decommission their CustomIpPrefix, or edit the tags or Cidr of the resource.
Examples
Example 1 : Commission the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Commission
The above command will start the commissioning process of the CustomIpPrefix.
Example 2 : Decommission the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Decommission
The above command will start the de-commissioning process of the CustomIpPrefix.
Example 3 : Provision the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Provision
The above command will start the provisioning process of the CustomIpPrefix.
Example 4 : Deprovision the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Deprovision
The above command will start the deprovisioning process of the CustomIpPrefix.
Example 5 : Update tags for the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Tag $tags
The above command will update the tags for the CustomIpPrefix.
Example 6 : Update CIDR for the CustomIpPrefix
Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr $cidr
The above command will update the cidr for the CustomIpPrefix. This would work only when resource is in validationfailed state.
Parameters
-AsJob
Run cmdlet in the background
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Cidr
The CIDR to update.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Commission
Commission the CustomIpPrefix resource
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Decommission
start decommissioning process.
Type: | SwitchParameter |
Aliases: | Decomission |
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: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Deprovision
Deprovision the CustomIpPrefix resource
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
The CustomIpPrefix to set.
Type: | PSCustomIpPrefix |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The resource name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-NoInternetAdvertise
Commission the CustomIpPrefix resource with no internet advertise
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Provision
Provision the CustomIpPrefix resource
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-ResourceId
The resource Id.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Tag
A hashtable which represents resource tags.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Related Links
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour