Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getCustomIPPrefix

Custom IP prefix resource. API Version: 2020-11-01.

Using getCustomIPPrefix

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomIPPrefix(args: GetCustomIPPrefixArgs, opts?: InvokeOptions): Promise<GetCustomIPPrefixResult>
function getCustomIPPrefixOutput(args: GetCustomIPPrefixOutputArgs, opts?: InvokeOptions): Output<GetCustomIPPrefixResult>
def get_custom_ip_prefix(custom_ip_prefix_name: Optional[str] = None,
                         expand: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomIPPrefixResult
def get_custom_ip_prefix_output(custom_ip_prefix_name: Optional[pulumi.Input[str]] = None,
                         expand: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomIPPrefixResult]
func LookupCustomIPPrefix(ctx *Context, args *LookupCustomIPPrefixArgs, opts ...InvokeOption) (*LookupCustomIPPrefixResult, error)
func LookupCustomIPPrefixOutput(ctx *Context, args *LookupCustomIPPrefixOutputArgs, opts ...InvokeOption) LookupCustomIPPrefixResultOutput

> Note: This function is named LookupCustomIPPrefix in the Go SDK.

public static class GetCustomIPPrefix 
{
    public static Task<GetCustomIPPrefixResult> InvokeAsync(GetCustomIPPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomIPPrefixResult> Invoke(GetCustomIPPrefixInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomIPPrefixResult> getCustomIPPrefix(GetCustomIPPrefixArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:network:getCustomIPPrefix
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CustomIpPrefixName string

The name of the custom IP prefix.

ResourceGroupName string

The name of the resource group.

Expand string

Expands referenced resources.

CustomIpPrefixName string

The name of the custom IP prefix.

ResourceGroupName string

The name of the resource group.

Expand string

Expands referenced resources.

customIpPrefixName String

The name of the custom IP prefix.

resourceGroupName String

The name of the resource group.

expand String

Expands referenced resources.

customIpPrefixName string

The name of the custom IP prefix.

resourceGroupName string

The name of the resource group.

expand string

Expands referenced resources.

custom_ip_prefix_name str

The name of the custom IP prefix.

resource_group_name str

The name of the resource group.

expand str

Expands referenced resources.

customIpPrefixName String

The name of the custom IP prefix.

resourceGroupName String

The name of the resource group.

expand String

Expands referenced resources.

getCustomIPPrefix Result

The following output properties are available:

Etag string

A unique read-only string that changes whenever the resource is updated.

Name string

Resource name.

ProvisioningState string

The provisioning state of the custom IP prefix resource.

PublicIpPrefixes List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>

The list of all referenced PublicIpPrefixes.

ResourceGuid string

The resource GUID property of the custom IP prefix resource.

Type string

Resource type.

Cidr string

The prefix range in CIDR notation. Should include the start address and the prefix length.

CommissionedState string

The commissioned state of the Custom IP Prefix.

ExtendedLocation Pulumi.AzureNative.Network.Outputs.ExtendedLocationResponse

The extended location of the custom IP prefix.

Id string

Resource ID.

Location string

Resource location.

Tags Dictionary<string, string>

Resource tags.

Zones List<string>

A list of availability zones denoting the IP allocated for the resource needs to come from.

Etag string

A unique read-only string that changes whenever the resource is updated.

Name string

Resource name.

ProvisioningState string

The provisioning state of the custom IP prefix resource.

PublicIpPrefixes []SubResourceResponse

The list of all referenced PublicIpPrefixes.

ResourceGuid string

The resource GUID property of the custom IP prefix resource.

Type string

Resource type.

Cidr string

The prefix range in CIDR notation. Should include the start address and the prefix length.

CommissionedState string

The commissioned state of the Custom IP Prefix.

ExtendedLocation ExtendedLocationResponse

The extended location of the custom IP prefix.

Id string

Resource ID.

Location string

Resource location.

Tags map[string]string

Resource tags.

Zones []string

A list of availability zones denoting the IP allocated for the resource needs to come from.

etag String

A unique read-only string that changes whenever the resource is updated.

name String

Resource name.

provisioningState String

The provisioning state of the custom IP prefix resource.

publicIpPrefixes List<SubResourceResponse>

The list of all referenced PublicIpPrefixes.

resourceGuid String

The resource GUID property of the custom IP prefix resource.

type String

Resource type.

cidr String

The prefix range in CIDR notation. Should include the start address and the prefix length.

commissionedState String

The commissioned state of the Custom IP Prefix.

extendedLocation ExtendedLocationResponse

The extended location of the custom IP prefix.

id String

Resource ID.

location String

Resource location.

tags Map<String,String>

Resource tags.

zones List<String>

A list of availability zones denoting the IP allocated for the resource needs to come from.

etag string

A unique read-only string that changes whenever the resource is updated.

name string

Resource name.

provisioningState string

The provisioning state of the custom IP prefix resource.

publicIpPrefixes SubResourceResponse[]

The list of all referenced PublicIpPrefixes.

resourceGuid string

The resource GUID property of the custom IP prefix resource.

type string

Resource type.

cidr string

The prefix range in CIDR notation. Should include the start address and the prefix length.

commissionedState string

The commissioned state of the Custom IP Prefix.

extendedLocation ExtendedLocationResponse

The extended location of the custom IP prefix.

id string

Resource ID.

location string

Resource location.

tags {[key: string]: string}

Resource tags.

zones string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

etag str

A unique read-only string that changes whenever the resource is updated.

name str

Resource name.

provisioning_state str

The provisioning state of the custom IP prefix resource.

public_ip_prefixes Sequence[SubResourceResponse]

The list of all referenced PublicIpPrefixes.

resource_guid str

The resource GUID property of the custom IP prefix resource.

type str

Resource type.

cidr str

The prefix range in CIDR notation. Should include the start address and the prefix length.

commissioned_state str

The commissioned state of the Custom IP Prefix.

extended_location ExtendedLocationResponse

The extended location of the custom IP prefix.

id str

Resource ID.

location str

Resource location.

tags Mapping[str, str]

Resource tags.

zones Sequence[str]

A list of availability zones denoting the IP allocated for the resource needs to come from.

etag String

A unique read-only string that changes whenever the resource is updated.

name String

Resource name.

provisioningState String

The provisioning state of the custom IP prefix resource.

publicIpPrefixes List<Property Map>

The list of all referenced PublicIpPrefixes.

resourceGuid String

The resource GUID property of the custom IP prefix resource.

type String

Resource type.

cidr String

The prefix range in CIDR notation. Should include the start address and the prefix length.

commissionedState String

The commissioned state of the Custom IP Prefix.

extendedLocation Property Map

The extended location of the custom IP prefix.

id String

Resource ID.

location String

Resource location.

tags Map<String>

Resource tags.

zones List<String>

A list of availability zones denoting the IP allocated for the resource needs to come from.

Supporting Types

ExtendedLocationResponse

Name string

The name of the extended location.

Type string

The type of the extended location.

Name string

The name of the extended location.

Type string

The type of the extended location.

name String

The name of the extended location.

type String

The type of the extended location.

name string

The name of the extended location.

type string

The type of the extended location.

name str

The name of the extended location.

type str

The type of the extended location.

name String

The name of the extended location.

type String

The type of the extended location.

SubResourceResponse

Id string

Resource ID.

Id string

Resource ID.

id String

Resource ID.

id string

Resource ID.

id str

Resource ID.

id String

Resource ID.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0