@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Public IP address resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class PublicIPAddress extends pulumi.CustomResource {
/**
* Get an existing PublicIPAddress resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PublicIPAddress;
/**
* Returns true if the given object is an instance of PublicIPAddress. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PublicIPAddress;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The DDoS protection custom policy associated with the public IP address.
*/
readonly ddosSettings: pulumi.Output<outputs.network.DdosSettingsResponse | undefined>;
/**
* Specify what happens to the public IP address when the VM using it is deleted
*/
readonly deleteOption: pulumi.Output<string | undefined>;
/**
* The FQDN of the DNS record associated with the public IP address.
*/
readonly dnsSettings: pulumi.Output<outputs.network.PublicIPAddressDnsSettingsResponse | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The extended location of the public ip address.
*/
readonly extendedLocation: pulumi.Output<outputs.network.ExtendedLocationResponse | undefined>;
/**
* The idle timeout of the public IP address.
*/
readonly idleTimeoutInMinutes: pulumi.Output<number | undefined>;
/**
* The IP address associated with the public IP address resource.
*/
readonly ipAddress: pulumi.Output<string | undefined>;
/**
* The IP configuration associated with the public IP address.
*/
readonly ipConfiguration: pulumi.Output<outputs.network.IPConfigurationResponse>;
/**
* The list of tags associated with the public IP address.
*/
readonly ipTags: pulumi.Output<outputs.network.IpTagResponse[] | undefined>;
/**
* The linked public IP address of the public IP address resource.
*/
readonly linkedPublicIPAddress: pulumi.Output<outputs.network.PublicIPAddressResponse | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Migration phase of Public IP Address.
*/
readonly migrationPhase: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The NatGateway for the Public IP address.
*/
readonly natGateway: pulumi.Output<outputs.network.NatGatewayResponse | undefined>;
/**
* The provisioning state of the public IP address resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The public IP address version.
*/
readonly publicIPAddressVersion: pulumi.Output<string | undefined>;
/**
* The public IP address allocation method.
*/
readonly publicIPAllocationMethod: pulumi.Output<string | undefined>;
/**
* The Public IP Prefix this Public IP Address should be allocated from.
*/
readonly publicIPPrefix: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The resource GUID property of the public IP address resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* The service public IP address of the public IP address resource.
*/
readonly servicePublicIPAddress: pulumi.Output<outputs.network.PublicIPAddressResponse | undefined>;
/**
* The public IP address SKU.
*/
readonly sku: pulumi.Output<outputs.network.PublicIPAddressSkuResponse | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* A list of availability zones denoting the IP allocated for the resource needs to come from.
*/
readonly zones: pulumi.Output<string[] | undefined>;
/**
* Create a PublicIPAddress resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PublicIPAddressArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PublicIPAddress resource.
*/
export interface PublicIPAddressArgs {
/**
* The DDoS protection custom policy associated with the public IP address.
*/
ddosSettings?: pulumi.Input<inputs.network.DdosSettingsArgs>;
/**
* Specify what happens to the public IP address when the VM using it is deleted
*/
deleteOption?: pulumi.Input<string | enums.network.DeleteOptions>;
/**
* The FQDN of the DNS record associated with the public IP address.
*/
dnsSettings?: pulumi.Input<inputs.network.PublicIPAddressDnsSettingsArgs>;
/**
* The extended location of the public ip address.
*/
extendedLocation?: pulumi.Input<inputs.network.ExtendedLocationArgs>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The idle timeout of the public IP address.
*/
idleTimeoutInMinutes?: pulumi.Input<number>;
/**
* The IP address associated with the public IP address resource.
*/
ipAddress?: pulumi.Input<string>;
/**
* The list of tags associated with the public IP address.
*/
ipTags?: pulumi.Input<pulumi.Input<inputs.network.IpTagArgs>[]>;
/**
* The linked public IP address of the public IP address resource.
*/
linkedPublicIPAddress?: pulumi.Input<inputs.network.PublicIPAddressArgs>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Migration phase of Public IP Address.
*/
migrationPhase?: pulumi.Input<string | enums.network.PublicIPAddressMigrationPhase>;
/**
* The NatGateway for the Public IP address.
*/
natGateway?: pulumi.Input<inputs.network.NatGatewayArgs>;
/**
* The public IP address version.
*/
publicIPAddressVersion?: pulumi.Input<string | enums.network.IPVersion>;
/**
* The public IP address allocation method.
*/
publicIPAllocationMethod?: pulumi.Input<string | enums.network.IPAllocationMethod>;
/**
* The Public IP Prefix this Public IP Address should be allocated from.
*/
publicIPPrefix?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The name of the public IP address.
*/
publicIpAddressName?: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The service public IP address of the public IP address resource.
*/
servicePublicIPAddress?: pulumi.Input<inputs.network.PublicIPAddressArgs>;
/**
* The public IP address SKU.
*/
sku?: pulumi.Input<inputs.network.PublicIPAddressSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A list of availability zones denoting the IP allocated for the resource needs to come from.
*/
zones?: pulumi.Input<pulumi.Input<string>[]>;
}