Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.nginx.getDeployment

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = azure.nginx.getDeployment({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);

import pulumi
import pulumi_azure as azure

example = azure.nginx.get_deployment(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/nginx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := nginx.LookupDeployment(ctx, &nginx.LookupDeploymentArgs{
			Name:              "existing",
			ResourceGroupName: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.Nginx.GetDeployment.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "existing",
    });

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

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.nginx.NginxFunctions;
import com.pulumi.azure.nginx.inputs.GetDeploymentArgs;
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 = NginxFunctions.getDeployment(GetDeploymentArgs.builder()
            .name("existing")
            .resourceGroupName("existing")
            .build());

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

variables:
  example:
    fn::invoke:
      function: azure:nginx:getDeployment
      arguments:
        name: existing
        resourceGroupName: existing
outputs:
  id: ${example.id}

Using getDeployment

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.

TypeScript
Python
Go
C#
Java
YAML

function getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>

def get_deployment(name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]

func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)

fn::invoke:
  function: azure:nginx/getDeployment:getDeployment
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of this NGINX Deployment.
ResourceGroupName string: The name of the Resource Group where the NGINX Deployment exists.

Name string: The name of this NGINX Deployment.
ResourceGroupName string: The name of the Resource Group where the NGINX Deployment exists.

name String: The name of this NGINX Deployment.
resourceGroupName String: The name of the Resource Group where the NGINX Deployment exists.

name string: The name of this NGINX Deployment.
resourceGroupName string: The name of the Resource Group where the NGINX Deployment exists.

name str: The name of this NGINX Deployment.
resource_group_name str: The name of the Resource Group where the NGINX Deployment exists.

name String: The name of this NGINX Deployment.
resourceGroupName String: The name of the Resource Group where the NGINX Deployment exists.

getDeployment Result

The following output properties are available:

AutoScaleProfiles List<GetDeploymentAutoScaleProfile>: An auto_scale_profile block as defined below.
AutomaticUpgradeChannel string: The automatic upgrade channel for this NGINX deployment.
Capacity int: The number of NGINX capacity units for this NGINX Deployment.
DataplaneApiEndpoint string: The dataplane API endpoint of the NGINX Deployment.
DiagnoseSupportEnabled bool: Whether metrics are exported to Azure Monitor.
Email string: Preferred email associated with the NGINX Deployment.
FrontendPrivates List<GetDeploymentFrontendPrivate>: A frontend_private block as defined below.
FrontendPublics List<GetDeploymentFrontendPublic>: A frontend_public block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetDeploymentIdentity>: A identity block as defined below.
IpAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
Location string: The Azure Region where the NGINX Deployment exists.
LoggingStorageAccounts List<GetDeploymentLoggingStorageAccount>: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
ManagedResourceGroup string: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
Name string: Name of the autoscaling profile.
NetworkInterfaces List<GetDeploymentNetworkInterface>: A network_interface block as defined below.
NginxVersion string: NGINX version of the Deployment.
ResourceGroupName string
Sku string: The NGINX Deployment SKU.
Tags Dictionary<string, string>: A mapping of tags assigned to the NGINX Deployment.

AutoScaleProfiles []GetDeploymentAutoScaleProfile: An auto_scale_profile block as defined below.
AutomaticUpgradeChannel string: The automatic upgrade channel for this NGINX deployment.
Capacity int: The number of NGINX capacity units for this NGINX Deployment.
DataplaneApiEndpoint string: The dataplane API endpoint of the NGINX Deployment.
DiagnoseSupportEnabled bool: Whether metrics are exported to Azure Monitor.
Email string: Preferred email associated with the NGINX Deployment.
FrontendPrivates []GetDeploymentFrontendPrivate: A frontend_private block as defined below.
FrontendPublics []GetDeploymentFrontendPublic: A frontend_public block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetDeploymentIdentity: A identity block as defined below.
IpAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
Location string: The Azure Region where the NGINX Deployment exists.
LoggingStorageAccounts []GetDeploymentLoggingStorageAccount: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
ManagedResourceGroup string: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
Name string: Name of the autoscaling profile.
NetworkInterfaces []GetDeploymentNetworkInterface: A network_interface block as defined below.
NginxVersion string: NGINX version of the Deployment.
ResourceGroupName string
Sku string: The NGINX Deployment SKU.
Tags map[string]string: A mapping of tags assigned to the NGINX Deployment.

autoScaleProfiles List<GetDeploymentAutoScaleProfile>: An auto_scale_profile block as defined below.
automaticUpgradeChannel String: The automatic upgrade channel for this NGINX deployment.
capacity Integer: The number of NGINX capacity units for this NGINX Deployment.
dataplaneApiEndpoint String: The dataplane API endpoint of the NGINX Deployment.
diagnoseSupportEnabled Boolean: Whether metrics are exported to Azure Monitor.
email String: Preferred email associated with the NGINX Deployment.
frontendPrivates List<GetDeploymentFrontendPrivate>: A frontend_private block as defined below.
frontendPublics List<GetDeploymentFrontendPublic>: A frontend_public block as defined below.
id String: The provider-assigned unique ID for this managed resource.
identities List<GetDeploymentIdentity>: A identity block as defined below.
ipAddress String: The list of Public IP Resource IDs for this NGINX Deployment.
location String: The Azure Region where the NGINX Deployment exists.
loggingStorageAccounts List<GetDeploymentLoggingStorageAccount>: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
managedResourceGroup String: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
name String: Name of the autoscaling profile.
networkInterfaces List<GetDeploymentNetworkInterface>: A network_interface block as defined below.
nginxVersion String: NGINX version of the Deployment.
resourceGroupName String
sku String: The NGINX Deployment SKU.
tags Map<String,String>: A mapping of tags assigned to the NGINX Deployment.

autoScaleProfiles GetDeploymentAutoScaleProfile[]: An auto_scale_profile block as defined below.
automaticUpgradeChannel string: The automatic upgrade channel for this NGINX deployment.
capacity number: The number of NGINX capacity units for this NGINX Deployment.
dataplaneApiEndpoint string: The dataplane API endpoint of the NGINX Deployment.
diagnoseSupportEnabled boolean: Whether metrics are exported to Azure Monitor.
email string: Preferred email associated with the NGINX Deployment.
frontendPrivates GetDeploymentFrontendPrivate[]: A frontend_private block as defined below.
frontendPublics GetDeploymentFrontendPublic[]: A frontend_public block as defined below.
id string: The provider-assigned unique ID for this managed resource.
identities GetDeploymentIdentity[]: A identity block as defined below.
ipAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
location string: The Azure Region where the NGINX Deployment exists.
loggingStorageAccounts GetDeploymentLoggingStorageAccount[]: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
managedResourceGroup string: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
name string: Name of the autoscaling profile.
networkInterfaces GetDeploymentNetworkInterface[]: A network_interface block as defined below.
nginxVersion string: NGINX version of the Deployment.
resourceGroupName string
sku string: The NGINX Deployment SKU.
tags {[key: string]: string}: A mapping of tags assigned to the NGINX Deployment.

auto_scale_profiles Sequence[GetDeploymentAutoScaleProfile]: An auto_scale_profile block as defined below.
automatic_upgrade_channel str: The automatic upgrade channel for this NGINX deployment.
capacity int: The number of NGINX capacity units for this NGINX Deployment.
dataplane_api_endpoint str: The dataplane API endpoint of the NGINX Deployment.
diagnose_support_enabled bool: Whether metrics are exported to Azure Monitor.
email str: Preferred email associated with the NGINX Deployment.
frontend_privates Sequence[GetDeploymentFrontendPrivate]: A frontend_private block as defined below.
frontend_publics Sequence[GetDeploymentFrontendPublic]: A frontend_public block as defined below.
id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetDeploymentIdentity]: A identity block as defined below.
ip_address str: The list of Public IP Resource IDs for this NGINX Deployment.
location str: The Azure Region where the NGINX Deployment exists.
logging_storage_accounts Sequence[GetDeploymentLoggingStorageAccount]: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
managed_resource_group str: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
name str: Name of the autoscaling profile.
network_interfaces Sequence[GetDeploymentNetworkInterface]: A network_interface block as defined below.
nginx_version str: NGINX version of the Deployment.
resource_group_name str
sku str: The NGINX Deployment SKU.
tags Mapping[str, str]: A mapping of tags assigned to the NGINX Deployment.

autoScaleProfiles List<Property Map>: An auto_scale_profile block as defined below.
automaticUpgradeChannel String: The automatic upgrade channel for this NGINX deployment.
capacity Number: The number of NGINX capacity units for this NGINX Deployment.
dataplaneApiEndpoint String: The dataplane API endpoint of the NGINX Deployment.
diagnoseSupportEnabled Boolean: Whether metrics are exported to Azure Monitor.
email String: Preferred email associated with the NGINX Deployment.
frontendPrivates List<Property Map>: A frontend_private block as defined below.
frontendPublics List<Property Map>: A frontend_public 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.
ipAddress String: The list of Public IP Resource IDs for this NGINX Deployment.
location String: The Azure Region where the NGINX Deployment exists.
loggingStorageAccounts List<Property Map>: Deprecated: The logging_storage_account block has been deprecated and will be removed in v5.0 of the AzureRM Provider.
managedResourceGroup String: Deprecated: The managed_resource_group field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider.
name String: Name of the autoscaling profile.
networkInterfaces List<Property Map>: A network_interface block as defined below.
nginxVersion String: NGINX version of the Deployment.
resourceGroupName String
sku String: The NGINX Deployment SKU.
tags Map<String>: A mapping of tags assigned to the NGINX Deployment.

Supporting Types

GetDeploymentAutoScaleProfile

MaxCapacity int: The maximum number of NGINX capacity units for this NGINX Deployment.
MinCapacity int: The minimum number of NGINX capacity units for this NGINX Deployment.
Name string: The name of this NGINX Deployment.

MaxCapacity int: The maximum number of NGINX capacity units for this NGINX Deployment.
MinCapacity int: The minimum number of NGINX capacity units for this NGINX Deployment.
Name string: The name of this NGINX Deployment.

maxCapacity Integer: The maximum number of NGINX capacity units for this NGINX Deployment.
minCapacity Integer: The minimum number of NGINX capacity units for this NGINX Deployment.
name String: The name of this NGINX Deployment.

maxCapacity number: The maximum number of NGINX capacity units for this NGINX Deployment.
minCapacity number: The minimum number of NGINX capacity units for this NGINX Deployment.
name string: The name of this NGINX Deployment.

max_capacity int: The maximum number of NGINX capacity units for this NGINX Deployment.
min_capacity int: The minimum number of NGINX capacity units for this NGINX Deployment.
name str: The name of this NGINX Deployment.

maxCapacity Number: The maximum number of NGINX capacity units for this NGINX Deployment.
minCapacity Number: The minimum number of NGINX capacity units for this NGINX Deployment.
name String: The name of this NGINX Deployment.

GetDeploymentFrontendPrivate

AllocationMethod string: The method of allocating the private IP to the NGINX Deployment.
IpAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
SubnetId string: The subnet resource ID of the NGINX Deployment.

AllocationMethod string: The method of allocating the private IP to the NGINX Deployment.
IpAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
SubnetId string: The subnet resource ID of the NGINX Deployment.

allocationMethod String: The method of allocating the private IP to the NGINX Deployment.
ipAddress String: The list of Public IP Resource IDs for this NGINX Deployment.
subnetId String: The subnet resource ID of the NGINX Deployment.

allocationMethod string: The method of allocating the private IP to the NGINX Deployment.
ipAddress string: The list of Public IP Resource IDs for this NGINX Deployment.
subnetId string: The subnet resource ID of the NGINX Deployment.

allocation_method str: The method of allocating the private IP to the NGINX Deployment.
ip_address str: The list of Public IP Resource IDs for this NGINX Deployment.
subnet_id str: The subnet resource ID of the NGINX Deployment.

allocationMethod String: The method of allocating the private IP to the NGINX Deployment.
ipAddress String: The list of Public IP Resource IDs for this NGINX Deployment.
subnetId String: The subnet resource ID of the NGINX Deployment.

GetDeploymentFrontendPublic

IpAddresses List<string>: The list of Public IP Resource IDs for this NGINX Deployment.

IpAddresses []string: The list of Public IP Resource IDs for this NGINX Deployment.

ipAddresses List<String>: The list of Public IP Resource IDs for this NGINX Deployment.

ipAddresses string[]: The list of Public IP Resource IDs for this NGINX Deployment.

ip_addresses Sequence[str]: The list of Public IP Resource IDs for this NGINX Deployment.

ipAddresses List<String>: The list of Public IP Resource IDs for this NGINX Deployment.

GetDeploymentIdentity

IdentityIds List<string>: List of identities attached to the NGINX Deployment.
PrincipalId string
TenantId string
Type string: Type of identity attached to the NGINX Deployment.

IdentityIds []string: List of identities attached to the NGINX Deployment.
PrincipalId string
TenantId string
Type string: Type of identity attached to the NGINX Deployment.

identityIds List<String>: List of identities attached to the NGINX Deployment.
principalId String
tenantId String
type String: Type of identity attached to the NGINX Deployment.

identityIds string[]: List of identities attached to the NGINX Deployment.
principalId string
tenantId string
type string: Type of identity attached to the NGINX Deployment.

identity_ids Sequence[str]: List of identities attached to the NGINX Deployment.
principal_id str
tenant_id str
type str: Type of identity attached to the NGINX Deployment.

identityIds List<String>: List of identities attached to the NGINX Deployment.
principalId String
tenantId String
type String: Type of identity attached to the NGINX Deployment.

GetDeploymentLoggingStorageAccount

ContainerName string
Name string: The name of this NGINX Deployment.

ContainerName string
Name string: The name of this NGINX Deployment.

containerName String
name String: The name of this NGINX Deployment.

containerName string
name string: The name of this NGINX Deployment.

container_name str
name str: The name of this NGINX Deployment.

containerName String
name String: The name of this NGINX Deployment.

GetDeploymentNetworkInterface

SubnetId string: The subnet resource ID of the NGINX Deployment.

SubnetId string: The subnet resource ID of the NGINX Deployment.

subnetId String: The subnet resource ID of the NGINX Deployment.

subnetId string: The subnet resource ID of the NGINX Deployment.

subnet_id str: The subnet resource ID of the NGINX Deployment.

subnetId String: The subnet resource ID of the NGINX Deployment.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.nginx.getDeployment

On this page

On this page

Example Usage

Using getDeployment

getDeployment Result

Supporting Types

GetDeploymentAutoScaleProfile

GetDeploymentFrontendPrivate

GetDeploymentFrontendPublic

GetDeploymentIdentity

GetDeploymentLoggingStorageAccount

GetDeploymentNetworkInterface

Package Details

On this page

On this page