PublicIPAddresses interface
Interface representing a PublicIPAddresses.
Methods
Method Details
beginCreateOrUpdate(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)
Creates or updates a static or dynamic public IP address.
function beginCreateOrUpdate(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
- parameters
- PublicIPAddress
Parameters supplied to the create or update public IP address operation.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<PublicIPAddress>, PublicIPAddress>>
beginCreateOrUpdateAndWait(string, string, PublicIPAddress, PublicIPAddressesCreateOrUpdateOptionalParams)
Creates or updates a static or dynamic public IP address.
function beginCreateOrUpdateAndWait(resourceGroupName: string, publicIpAddressName: string, parameters: PublicIPAddress, options?: PublicIPAddressesCreateOrUpdateOptionalParams): Promise<PublicIPAddress>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
- parameters
- PublicIPAddress
Parameters supplied to the create or update public IP address operation.
The options parameters.
Returns
Promise<PublicIPAddress>
beginDdosProtectionStatus(string, string, PublicIPAddressesDdosProtectionStatusOptionalParams)
Gets the Ddos Protection Status of a Public IP Address
function beginDdosProtectionStatus(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams): Promise<SimplePollerLike<OperationState<PublicIpDdosProtectionStatusResult>, PublicIpDdosProtectionStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
The options parameters.
Returns
beginDdosProtectionStatusAndWait(string, string, PublicIPAddressesDdosProtectionStatusOptionalParams)
Gets the Ddos Protection Status of a Public IP Address
function beginDdosProtectionStatusAndWait(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDdosProtectionStatusOptionalParams): Promise<PublicIpDdosProtectionStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
The options parameters.
Returns
Promise<PublicIpDdosProtectionStatusResult>
beginDelete(string, string, PublicIPAddressesDeleteOptionalParams)
Deletes the specified public IP address.
function beginDelete(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, PublicIPAddressesDeleteOptionalParams)
Deletes the specified public IP address.
function beginDeleteAndWait(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
The options parameters.
Returns
Promise<void>
get(string, string, PublicIPAddressesGetOptionalParams)
Gets the specified public IP address in a specified resource group.
function get(resourceGroupName: string, publicIpAddressName: string, options?: PublicIPAddressesGetOptionalParams): Promise<PublicIPAddress>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
The options parameters.
Returns
Promise<PublicIPAddress>
getCloudServicePublicIPAddress(string, string, string, string, string, string, PublicIPAddressesGetCloudServicePublicIPAddressOptionalParams)
Get the specified public IP address in a cloud service.
function getCloudServicePublicIPAddress(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetCloudServicePublicIPAddressOptionalParams): Promise<PublicIPAddress>Parameters
- resourceGroupName
-
string
The name of the resource group.
- cloudServiceName
-
string
The name of the cloud service.
- roleInstanceName
-
string
The role instance name.
- networkInterfaceName
-
string
The name of the network interface.
- ipConfigurationName
-
string
The name of the IP configuration.
- publicIpAddressName
-
string
The name of the public IP Address.
The options parameters.
Returns
Promise<PublicIPAddress>
getVirtualMachineScaleSetPublicIPAddress(string, string, string, string, string, string, PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressOptionalParams)
Get the specified public IP address in a virtual machine scale set.
function getVirtualMachineScaleSetPublicIPAddress(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, publicIpAddressName: string, options?: PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressOptionalParams): Promise<PublicIPAddress>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineScaleSetName
-
string
The name of the virtual machine scale set.
- virtualmachineIndex
-
string
The virtual machine index.
- networkInterfaceName
-
string
The name of the network interface.
- ipConfigurationName
-
string
The name of the IP configuration.
- publicIpAddressName
-
string
The name of the public IP Address.
The options parameters.
Returns
Promise<PublicIPAddress>
list(string, PublicIPAddressesListOptionalParams)
Gets all public IP addresses in a resource group.
function list(resourceGroupName: string, options?: PublicIPAddressesListOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listAll(PublicIPAddressesListAllOptionalParams)
Gets all the public IP addresses in a subscription.
function listAll(options?: PublicIPAddressesListAllOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
The options parameters.
Returns
listCloudServicePublicIPAddresses(string, string, PublicIPAddressesListCloudServicePublicIPAddressesOptionalParams)
Gets information about all public IP addresses on a cloud service level.
function listCloudServicePublicIPAddresses(resourceGroupName: string, cloudServiceName: string, options?: PublicIPAddressesListCloudServicePublicIPAddressesOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- cloudServiceName
-
string
The name of the cloud service.
The options parameters.
Returns
listCloudServiceRoleInstancePublicIPAddresses(string, string, string, string, string, PublicIPAddressesListCloudServiceRoleInstancePublicIPAddressesOptionalParams)
Gets information about all public IP addresses in a role instance IP configuration in a cloud service.
function listCloudServiceRoleInstancePublicIPAddresses(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListCloudServiceRoleInstancePublicIPAddressesOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- cloudServiceName
-
string
The name of the cloud service.
- roleInstanceName
-
string
The name of role instance.
- networkInterfaceName
-
string
The network interface name.
- ipConfigurationName
-
string
The IP configuration name.
The options parameters.
Returns
listVirtualMachineScaleSetPublicIPAddresses(string, string, PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesOptionalParams)
Gets information about all public IP addresses on a virtual machine scale set level.
function listVirtualMachineScaleSetPublicIPAddresses(resourceGroupName: string, virtualMachineScaleSetName: string, options?: PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineScaleSetName
-
string
The name of the virtual machine scale set.
The options parameters.
Returns
listVirtualMachineScaleSetVMPublicIPAddresses(string, string, string, string, string, PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesOptionalParams)
Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.
function listVirtualMachineScaleSetVMPublicIPAddresses(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, options?: PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesOptionalParams): PagedAsyncIterableIterator<PublicIPAddress, PublicIPAddress[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineScaleSetName
-
string
The name of the virtual machine scale set.
- virtualmachineIndex
-
string
The virtual machine index.
- networkInterfaceName
-
string
The network interface name.
- ipConfigurationName
-
string
The IP configuration name.
The options parameters.
Returns
updateTags(string, string, TagsObject, PublicIPAddressesUpdateTagsOptionalParams)
Updates public IP address tags.
function updateTags(resourceGroupName: string, publicIpAddressName: string, parameters: TagsObject, options?: PublicIPAddressesUpdateTagsOptionalParams): Promise<PublicIPAddress>Parameters
- resourceGroupName
-
string
The name of the resource group.
- publicIpAddressName
-
string
The name of the public IP address.
- parameters
- TagsObject
Parameters supplied to update public IP address tags.
The options parameters.
Returns
Promise<PublicIPAddress>