Azure Classic v5.38.0, Mar 21 23

azure.network.getApplicationGateway

Use this data source to access information about an existing Application Gateway.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Network.GetApplicationGateway.Invoke(new()
    {
        Name = "existing-app-gateway",
        ResourceGroupName = "existing-resources",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getApplicationGatewayResult => getApplicationGatewayResult.Id),
    };
});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := network.LookupApplicationGateway(ctx, &network.LookupApplicationGatewayArgs{
			Name:              "existing-app-gateway",
			ResourceGroupName: "existing-resources",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetApplicationGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworkFunctions.getApplicationGateway(GetApplicationGatewayArgs.builder()
            .name("existing-app-gateway")
            .resourceGroupName("existing-resources")
            .build());

        ctx.export("id", example.applyValue(getApplicationGatewayResult -> getApplicationGatewayResult.id()));
    }
}

import pulumi
import pulumi_azure as azure

example = azure.network.get_application_gateway(name="existing-app-gateway",
    resource_group_name="existing-resources")
pulumi.export("id", example.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getApplicationGateway({
    name: "existing-app-gateway",
    resourceGroupName: "existing-resources",
});
export const id = example.then(example => example.id);

variables:
  example:
    fn::invoke:
      Function: azure:network:getApplicationGateway
      Arguments:
        name: existing-app-gateway
        resourceGroupName: existing-resources
outputs:
  id: ${example.id}

Using getApplicationGateway

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 getApplicationGateway(args: GetApplicationGatewayArgs, opts?: InvokeOptions): Promise<GetApplicationGatewayResult>
function getApplicationGatewayOutput(args: GetApplicationGatewayOutputArgs, opts?: InvokeOptions): Output<GetApplicationGatewayResult>

def get_application_gateway(name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetApplicationGatewayResult
def get_application_gateway_output(name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetApplicationGatewayResult]

func LookupApplicationGateway(ctx *Context, args *LookupApplicationGatewayArgs, opts ...InvokeOption) (*LookupApplicationGatewayResult, error)
func LookupApplicationGatewayOutput(ctx *Context, args *LookupApplicationGatewayOutputArgs, opts ...InvokeOption) LookupApplicationGatewayResultOutput

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

public static class GetApplicationGateway 
{
    public static Task<GetApplicationGatewayResult> InvokeAsync(GetApplicationGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationGatewayResult> Invoke(GetApplicationGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApplicationGatewayResult> getApplicationGateway(GetApplicationGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:network/getApplicationGateway:getApplicationGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of this Application Gateway.
ResourceGroupName string: The name of the Resource Group where the Application Gateway exists.

Name string: The name of this Application Gateway.
ResourceGroupName string: The name of the Resource Group where the Application Gateway exists.

name String: The name of this Application Gateway.
resourceGroupName String: The name of the Resource Group where the Application Gateway exists.

name string: The name of this Application Gateway.
resourceGroupName string: The name of the Resource Group where the Application Gateway exists.

name str: The name of this Application Gateway.
resource_group_name str: The name of the Resource Group where the Application Gateway exists.

name String: The name of this Application Gateway.
resourceGroupName String: The name of the Resource Group where the Application Gateway exists.

getApplicationGateway Result

The following output properties are available:

BackendAddressPools List<GetApplicationGatewayBackendAddressPool>: A backend_address_pool block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetApplicationGatewayIdentity>: A identity block as defined below.
Location string: The Azure Region where the Application Gateway exists.
Name string: The name of the Backend Address Pool.
ResourceGroupName string
Tags Dictionary<string, string>: A mapping of tags assigned to the Application Gateway.

BackendAddressPools []GetApplicationGatewayBackendAddressPool: A backend_address_pool block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetApplicationGatewayIdentity: A identity block as defined below.
Location string: The Azure Region where the Application Gateway exists.
Name string: The name of the Backend Address Pool.
ResourceGroupName string
Tags map[string]string: A mapping of tags assigned to the Application Gateway.

backendAddressPools List<GetApplicationGatewayBackendAddressPool>: A backend_address_pool block as defined below.
id String: The provider-assigned unique ID for this managed resource.
identities List<GetApplicationGatewayIdentity>: A identity block as defined below.
location String: The Azure Region where the Application Gateway exists.
name String: The name of the Backend Address Pool.
resourceGroupName String
tags Map<String,String>: A mapping of tags assigned to the Application Gateway.

backendAddressPools GetApplicationGatewayBackendAddressPool[]: A backend_address_pool block as defined below.
id string: The provider-assigned unique ID for this managed resource.
identities GetApplicationGatewayIdentity[]: A identity block as defined below.
location string: The Azure Region where the Application Gateway exists.
name string: The name of the Backend Address Pool.
resourceGroupName string
tags {[key: string]: string}: A mapping of tags assigned to the Application Gateway.

backend_address_pools Sequence[GetApplicationGatewayBackendAddressPool]: A backend_address_pool block as defined below.
id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetApplicationGatewayIdentity]: A identity block as defined below.
location str: The Azure Region where the Application Gateway exists.
name str: The name of the Backend Address Pool.
resource_group_name str
tags Mapping[str, str]: A mapping of tags assigned to the Application Gateway.

backendAddressPools List<Property Map>: A backend_address_pool block as defined below.
id String: The provider-assigned unique ID for this managed resource.
identities List<Property Map>: A identity block as defined below.
location String: The Azure Region where the Application Gateway exists.
name String: The name of the Backend Address Pool.
resourceGroupName String
tags Map<String>: A mapping of tags assigned to the Application Gateway.

Supporting Types

GetApplicationGatewayBackendAddressPool

Fqdns List<string>: A list of FQDN's that are included in the Backend Address Pool.
Id string: The ID of the Backend Address Pool.
IpAddresses List<string>: A list of IP Addresses that are included in the Backend Address Pool.
Name string: The name of this Application Gateway.

Fqdns []string: A list of FQDN's that are included in the Backend Address Pool.
Id string: The ID of the Backend Address Pool.
IpAddresses []string: A list of IP Addresses that are included in the Backend Address Pool.
Name string: The name of this Application Gateway.

fqdns List<String>: A list of FQDN's that are included in the Backend Address Pool.
id String: The ID of the Backend Address Pool.
ipAddresses List<String>: A list of IP Addresses that are included in the Backend Address Pool.
name String: The name of this Application Gateway.

fqdns string[]: A list of FQDN's that are included in the Backend Address Pool.
id string: The ID of the Backend Address Pool.
ipAddresses string[]: A list of IP Addresses that are included in the Backend Address Pool.
name string: The name of this Application Gateway.

fqdns Sequence[str]: A list of FQDN's that are included in the Backend Address Pool.
id str: The ID of the Backend Address Pool.
ip_addresses Sequence[str]: A list of IP Addresses that are included in the Backend Address Pool.
name str: The name of this Application Gateway.

fqdns List<String>: A list of FQDN's that are included in the Backend Address Pool.
id String: The ID of the Backend Address Pool.
ipAddresses List<String>: A list of IP Addresses that are included in the Backend Address Pool.
name String: The name of this Application Gateway.

GetApplicationGatewayIdentity

IdentityIds List<string>: A list of Managed Identity IDs assigned to this Application Gateway.
Type string: The type of Managed Identity assigned to this Application Gateway.

IdentityIds []string: A list of Managed Identity IDs assigned to this Application Gateway.
Type string: The type of Managed Identity assigned to this Application Gateway.

identityIds List<String>: A list of Managed Identity IDs assigned to this Application Gateway.
type String: The type of Managed Identity assigned to this Application Gateway.

identityIds string[]: A list of Managed Identity IDs assigned to this Application Gateway.
type string: The type of Managed Identity assigned to this Application Gateway.

identity_ids Sequence[str]: A list of Managed Identity IDs assigned to this Application Gateway.
type str: The type of Managed Identity assigned to this Application Gateway.

identityIds List<String>: A list of Managed Identity IDs assigned to this Application Gateway.
type String: The type of Managed Identity assigned to this Application Gateway.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.