Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
System.Management.Automation.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:
System.Management.Automation.PSObject
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
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
-EndIPAddress
The ending IP address.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Location
The region where the resource is located.
Parameter properties
Type:
System.String
Default value:
(Get-AzLocation)[0].Location
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
-Name
IP pool name.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NoWait
Run the command asynchronously
Parameter properties
Type:
System.Management.Automation.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
-NumberOfAllocatedIPAddress
The number of currently allocated IP addresses.
Parameter properties
Type:
System.Int64
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NumberOfIPAddress
The total number of IP addresses.
Parameter properties
Type:
System.Int64
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NumberOfIPAddressesInTransition
The current number of IP addresses in transition.
Parameter properties
Type:
System.Int64
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Pool
This resource defines the range of IP addresses from which addresses are allocated for nodes within a subnet.
To construct, see NOTES section for POOL properties and create a hash table.
Subscription credentials that uniquely identify Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type:
System.String
Default value:
(Get-AzContext).Subscription.Id
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
-Tag
List of key-value pairs.
Parameter properties
Type:
System.Collections.Hashtable
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
System.Management.Automation.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.
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
POOL <IIPPool>: This resource defines the range of IP addresses from which addresses are allocated for nodes within a subnet.
[Location <String>]: The region where the resource is located.
[Tag \<IResourceTags>]: List of key-value pairs.
[(Any) <String>]: This indicates any property can be added to this object.
[AddressPrefix <String>]: The address prefix.
[EndIPAddress <String>]: The ending IP address.
[NumberOfAllocatedIPAddresses <Int64?>]: The number of currently allocated IP addresses.
[NumberOfIPAddresses <Int64?>]: The total number of IP addresses.
[NumberOfIPAddressesInTransition <Int64?>]: The current number of IP addresses in transition.
[StartIPAddress <String>]: The starting IP address.