Update-AzCustomIpPrefix
Syntax
UpdateByNameParameterSet (Default)
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>]
UpdateByResourceIdParameterSet
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.
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
Parameter properties
Type: SwitchParameter
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: False Value from remaining arguments: False
-Cidr
The CIDR to update.
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
-Commission
Commission the CustomIpPrefix resource
Parameter properties
Type: SwitchParameter
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: False Value from remaining arguments: False
-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
-Decommission
start decommissioning process.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: Decomission
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
-Deprovision
Deprovision the CustomIpPrefix resource
Parameter properties
Type: SwitchParameter
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: False Value from remaining arguments: False
The CustomIpPrefix to set.
Type: PSCustomIpPrefix
Default value: None Supports wildcards: False DontShow: False
UpdateByInputObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The resource name.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-NoInternetAdvertise
Commission the CustomIpPrefix resource with no internet advertise
Parameter properties
Type: SwitchParameter
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: False Value from remaining arguments: False
-Provision
Provision the CustomIpPrefix resource
Parameter properties
Type: SwitchParameter
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: False Value from remaining arguments: False
-ResourceGroupName
The resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
The resource Id.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
UpdateByResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Tag
A hashtable which represents resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
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
