Edit

Share via

Set-AzPublicIpPrefix

  • Reference
Module:
Az.Network

Sets the Tags for an existing PublicIpPrefix

Syntax

Set-AzPublicIpPrefix
   -PublicIpPrefix <PSPublicIpPrefix>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzPublicIpPrefix cmdlet sets the Tags for a public IP prefix.

Examples

Example 1: Set the tags for public ip prefix

$publicIpPrefix = Get-AzPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName

$publicIpPrefix.Tags = "TestTag"

Set-AzPublicIpPrefix -PublicIpPrefix $publicIpPrefix

The first command gets an existing public IP Prefix, the second command sets the Tags Property and the third command updates the existing object.

Parameters

-AsJob

Run cmdlet in the background

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

-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

-PublicIpPrefix

The PublicIpPrefix

Type:PSPublicIpPrefix
Position:Named
Default value:None
Required:True
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

PSPublicIpPrefix

Outputs

PSPublicIpPrefix