Azure Native v1.102.0, May 2 23

azure-native.network.getIpAllocation

Explore with Pulumi AI

Gets the specified IpAllocation by resource group. API Version: 2020-11-01.

Using getIpAllocation

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 getIpAllocation(args: GetIpAllocationArgs, opts?: InvokeOptions): Promise<GetIpAllocationResult>
function getIpAllocationOutput(args: GetIpAllocationOutputArgs, opts?: InvokeOptions): Output<GetIpAllocationResult>

def get_ip_allocation(expand: Optional[str] = None,
                      ip_allocation_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIpAllocationResult
def get_ip_allocation_output(expand: Optional[pulumi.Input[str]] = None,
                      ip_allocation_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIpAllocationResult]

func LookupIpAllocation(ctx *Context, args *LookupIpAllocationArgs, opts ...InvokeOption) (*LookupIpAllocationResult, error)
func LookupIpAllocationOutput(ctx *Context, args *LookupIpAllocationOutputArgs, opts ...InvokeOption) LookupIpAllocationResultOutput

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

public static class GetIpAllocation 
{
    public static Task<GetIpAllocationResult> InvokeAsync(GetIpAllocationArgs args, InvokeOptions? opts = null)
    public static Output<GetIpAllocationResult> Invoke(GetIpAllocationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpAllocationResult> getIpAllocation(GetIpAllocationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getIpAllocation
  arguments:
    # arguments dictionary

The following arguments are supported:

IpAllocationName string: The name of the IpAllocation.
ResourceGroupName string: The name of the resource group.
Expand string: Expands referenced resources.

IpAllocationName string: The name of the IpAllocation.
ResourceGroupName string: The name of the resource group.
Expand string: Expands referenced resources.

ipAllocationName String: The name of the IpAllocation.
resourceGroupName String: The name of the resource group.
expand String: Expands referenced resources.

ipAllocationName string: The name of the IpAllocation.
resourceGroupName string: The name of the resource group.
expand string: Expands referenced resources.

ip_allocation_name str: The name of the IpAllocation.
resource_group_name str: The name of the resource group.
expand str: Expands referenced resources.

ipAllocationName String: The name of the IpAllocation.
resourceGroupName String: The name of the resource group.
expand String: Expands referenced resources.

getIpAllocation 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.
Subnet Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The Subnet that using the prefix of this IpAllocation resource.
Type string: Resource type.
VirtualNetwork Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The VirtualNetwork that using the prefix of this IpAllocation resource.
AllocationTags Dictionary<string, string>: IpAllocation tags.
Id string: Resource ID.
IpamAllocationId string: The IPAM allocation ID.
Location string: Resource location.
Prefix string: The address prefix for the IpAllocation.
PrefixLength int: The address prefix length for the IpAllocation.
PrefixType string: The address prefix Type for the IpAllocation.
Tags Dictionary<string, string>: Resource tags.

Etag string: A unique read-only string that changes whenever the resource is updated.
Name string: Resource name.
Subnet SubResourceResponse: The Subnet that using the prefix of this IpAllocation resource.
Type string: Resource type.
VirtualNetwork SubResourceResponse: The VirtualNetwork that using the prefix of this IpAllocation resource.
AllocationTags map[string]string: IpAllocation tags.
Id string: Resource ID.
IpamAllocationId string: The IPAM allocation ID.
Location string: Resource location.
Prefix string: The address prefix for the IpAllocation.
PrefixLength int: The address prefix length for the IpAllocation.
PrefixType string: The address prefix Type for the IpAllocation.
Tags map[string]string: Resource tags.

etag String: A unique read-only string that changes whenever the resource is updated.
name String: Resource name.
subnet SubResourceResponse: The Subnet that using the prefix of this IpAllocation resource.
type String: Resource type.
virtualNetwork SubResourceResponse: The VirtualNetwork that using the prefix of this IpAllocation resource.
allocationTags Map<String,String>: IpAllocation tags.
id String: Resource ID.
ipamAllocationId String: The IPAM allocation ID.
location String: Resource location.
prefix String: The address prefix for the IpAllocation.
prefixLength Integer: The address prefix length for the IpAllocation.
prefixType String: The address prefix Type for the IpAllocation.
tags Map<String,String>: Resource tags.

etag string: A unique read-only string that changes whenever the resource is updated.
name string: Resource name.
subnet SubResourceResponse: The Subnet that using the prefix of this IpAllocation resource.
type string: Resource type.
virtualNetwork SubResourceResponse: The VirtualNetwork that using the prefix of this IpAllocation resource.
allocationTags {[key: string]: string}: IpAllocation tags.
id string: Resource ID.
ipamAllocationId string: The IPAM allocation ID.
location string: Resource location.
prefix string: The address prefix for the IpAllocation.
prefixLength number: The address prefix length for the IpAllocation.
prefixType string: The address prefix Type for the IpAllocation.
tags {[key: string]: string}: Resource tags.

etag str: A unique read-only string that changes whenever the resource is updated.
name str: Resource name.
subnet SubResourceResponse: The Subnet that using the prefix of this IpAllocation resource.
type str: Resource type.
virtual_network SubResourceResponse: The VirtualNetwork that using the prefix of this IpAllocation resource.
allocation_tags Mapping[str, str]: IpAllocation tags.
id str: Resource ID.
ipam_allocation_id str: The IPAM allocation ID.
location str: Resource location.
prefix str: The address prefix for the IpAllocation.
prefix_length int: The address prefix length for the IpAllocation.
prefix_type str: The address prefix Type for the IpAllocation.
tags Mapping[str, str]: Resource tags.

etag String: A unique read-only string that changes whenever the resource is updated.
name String: Resource name.
subnet Property Map: The Subnet that using the prefix of this IpAllocation resource.
type String: Resource type.
virtualNetwork Property Map: The VirtualNetwork that using the prefix of this IpAllocation resource.
allocationTags Map<String>: IpAllocation tags.
id String: Resource ID.
ipamAllocationId String: The IPAM allocation ID.
location String: Resource location.
prefix String: The address prefix for the IpAllocation.
prefixLength Number: The address prefix length for the IpAllocation.
prefixType String: The address prefix Type for the IpAllocation.
tags Map<String>: Resource tags.

Supporting Types

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: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0