1. Packages
  2. Azure Classic
  3. API Docs
  4. nginx
  5. Deployment

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.nginx.Deployment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an NGINX Deployment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "West Europe",
    });
    const examplePublicIp = new azure.network.PublicIp("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        allocationMethod: "Static",
        sku: "Standard",
        tags: {
            environment: "Production",
        },
    });
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
        name: "example-vnet",
        addressSpaces: ["10.0.0.0/16"],
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleSubnet = new azure.network.Subnet("example", {
        name: "example-subnet",
        resourceGroupName: example.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.0.2.0/24"],
        delegations: [{
            name: "delegation",
            serviceDelegation: {
                name: "NGINX.NGINXPLUS/nginxDeployments",
                actions: ["Microsoft.Network/virtualNetworks/subnets/join/action"],
            },
        }],
    });
    const exampleDeployment = new azure.nginx.Deployment("example", {
        name: "example-nginx",
        resourceGroupName: example.name,
        sku: "standardv2_Monthly",
        location: example.location,
        managedResourceGroup: "example",
        diagnoseSupportEnabled: true,
        automaticUpgradeChannel: "stable",
        frontendPublic: {
            ipAddresses: [examplePublicIp.id],
        },
        networkInterfaces: [{
            subnetId: exampleSubnet.id,
        }],
        capacity: 20,
        email: "user@test.com",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="West Europe")
    example_public_ip = azure.network.PublicIp("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        allocation_method="Static",
        sku="Standard",
        tags={
            "environment": "Production",
        })
    example_virtual_network = azure.network.VirtualNetwork("example",
        name="example-vnet",
        address_spaces=["10.0.0.0/16"],
        location=example.location,
        resource_group_name=example.name)
    example_subnet = azure.network.Subnet("example",
        name="example-subnet",
        resource_group_name=example.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.0.2.0/24"],
        delegations=[{
            "name": "delegation",
            "service_delegation": {
                "name": "NGINX.NGINXPLUS/nginxDeployments",
                "actions": ["Microsoft.Network/virtualNetworks/subnets/join/action"],
            },
        }])
    example_deployment = azure.nginx.Deployment("example",
        name="example-nginx",
        resource_group_name=example.name,
        sku="standardv2_Monthly",
        location=example.location,
        managed_resource_group="example",
        diagnose_support_enabled=True,
        automatic_upgrade_channel="stable",
        frontend_public={
            "ip_addresses": [example_public_ip.id],
        },
        network_interfaces=[{
            "subnet_id": example_subnet.id,
        }],
        capacity=20,
        email="user@test.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
    	"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 := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
    			Name:              pulumi.String("example"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			AllocationMethod:  pulumi.String("Static"),
    			Sku:               pulumi.String("Standard"),
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
    			Name: pulumi.String("example-vnet"),
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.0.0.0/16"),
    			},
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
    			Name:               pulumi.String("example-subnet"),
    			ResourceGroupName:  example.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.0.2.0/24"),
    			},
    			Delegations: network.SubnetDelegationArray{
    				&network.SubnetDelegationArgs{
    					Name: pulumi.String("delegation"),
    					ServiceDelegation: &network.SubnetDelegationServiceDelegationArgs{
    						Name: pulumi.String("NGINX.NGINXPLUS/nginxDeployments"),
    						Actions: pulumi.StringArray{
    							pulumi.String("Microsoft.Network/virtualNetworks/subnets/join/action"),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = nginx.NewDeployment(ctx, "example", &nginx.DeploymentArgs{
    			Name:                    pulumi.String("example-nginx"),
    			ResourceGroupName:       example.Name,
    			Sku:                     pulumi.String("standardv2_Monthly"),
    			Location:                example.Location,
    			ManagedResourceGroup:    pulumi.String("example"),
    			DiagnoseSupportEnabled:  pulumi.Bool(true),
    			AutomaticUpgradeChannel: pulumi.String("stable"),
    			FrontendPublic: &nginx.DeploymentFrontendPublicArgs{
    				IpAddresses: pulumi.StringArray{
    					examplePublicIp.ID(),
    				},
    			},
    			NetworkInterfaces: nginx.DeploymentNetworkInterfaceArray{
    				&nginx.DeploymentNetworkInterfaceArgs{
    					SubnetId: exampleSubnet.ID(),
    				},
    			},
    			Capacity: pulumi.Int(20),
    			Email:    pulumi.String("user@test.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-rg",
            Location = "West Europe",
        });
    
        var examplePublicIp = new Azure.Network.PublicIp("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AllocationMethod = "Static",
            Sku = "Standard",
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    
        var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
        {
            Name = "example-vnet",
            AddressSpaces = new[]
            {
                "10.0.0.0/16",
            },
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleSubnet = new Azure.Network.Subnet("example", new()
        {
            Name = "example-subnet",
            ResourceGroupName = example.Name,
            VirtualNetworkName = exampleVirtualNetwork.Name,
            AddressPrefixes = new[]
            {
                "10.0.2.0/24",
            },
            Delegations = new[]
            {
                new Azure.Network.Inputs.SubnetDelegationArgs
                {
                    Name = "delegation",
                    ServiceDelegation = new Azure.Network.Inputs.SubnetDelegationServiceDelegationArgs
                    {
                        Name = "NGINX.NGINXPLUS/nginxDeployments",
                        Actions = new[]
                        {
                            "Microsoft.Network/virtualNetworks/subnets/join/action",
                        },
                    },
                },
            },
        });
    
        var exampleDeployment = new Azure.Nginx.Deployment("example", new()
        {
            Name = "example-nginx",
            ResourceGroupName = example.Name,
            Sku = "standardv2_Monthly",
            Location = example.Location,
            ManagedResourceGroup = "example",
            DiagnoseSupportEnabled = true,
            AutomaticUpgradeChannel = "stable",
            FrontendPublic = new Azure.Nginx.Inputs.DeploymentFrontendPublicArgs
            {
                IpAddresses = new[]
                {
                    examplePublicIp.Id,
                },
            },
            NetworkInterfaces = new[]
            {
                new Azure.Nginx.Inputs.DeploymentNetworkInterfaceArgs
                {
                    SubnetId = exampleSubnet.Id,
                },
            },
            Capacity = 20,
            Email = "user@test.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.network.PublicIp;
    import com.pulumi.azure.network.PublicIpArgs;
    import com.pulumi.azure.network.VirtualNetwork;
    import com.pulumi.azure.network.VirtualNetworkArgs;
    import com.pulumi.azure.network.Subnet;
    import com.pulumi.azure.network.SubnetArgs;
    import com.pulumi.azure.network.inputs.SubnetDelegationArgs;
    import com.pulumi.azure.network.inputs.SubnetDelegationServiceDelegationArgs;
    import com.pulumi.azure.nginx.Deployment;
    import com.pulumi.azure.nginx.DeploymentArgs;
    import com.pulumi.azure.nginx.inputs.DeploymentFrontendPublicArgs;
    import com.pulumi.azure.nginx.inputs.DeploymentNetworkInterfaceArgs;
    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) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-rg")
                .location("West Europe")
                .build());
    
            var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .allocationMethod("Static")
                .sku("Standard")
                .tags(Map.of("environment", "Production"))
                .build());
    
            var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
                .name("example-vnet")
                .addressSpaces("10.0.0.0/16")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
                .name("example-subnet")
                .resourceGroupName(example.name())
                .virtualNetworkName(exampleVirtualNetwork.name())
                .addressPrefixes("10.0.2.0/24")
                .delegations(SubnetDelegationArgs.builder()
                    .name("delegation")
                    .serviceDelegation(SubnetDelegationServiceDelegationArgs.builder()
                        .name("NGINX.NGINXPLUS/nginxDeployments")
                        .actions("Microsoft.Network/virtualNetworks/subnets/join/action")
                        .build())
                    .build())
                .build());
    
            var exampleDeployment = new Deployment("exampleDeployment", DeploymentArgs.builder()
                .name("example-nginx")
                .resourceGroupName(example.name())
                .sku("standardv2_Monthly")
                .location(example.location())
                .managedResourceGroup("example")
                .diagnoseSupportEnabled(true)
                .automaticUpgradeChannel("stable")
                .frontendPublic(DeploymentFrontendPublicArgs.builder()
                    .ipAddresses(examplePublicIp.id())
                    .build())
                .networkInterfaces(DeploymentNetworkInterfaceArgs.builder()
                    .subnetId(exampleSubnet.id())
                    .build())
                .capacity(20)
                .email("user@test.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: West Europe
      examplePublicIp:
        type: azure:network:PublicIp
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          allocationMethod: Static
          sku: Standard
          tags:
            environment: Production
      exampleVirtualNetwork:
        type: azure:network:VirtualNetwork
        name: example
        properties:
          name: example-vnet
          addressSpaces:
            - 10.0.0.0/16
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleSubnet:
        type: azure:network:Subnet
        name: example
        properties:
          name: example-subnet
          resourceGroupName: ${example.name}
          virtualNetworkName: ${exampleVirtualNetwork.name}
          addressPrefixes:
            - 10.0.2.0/24
          delegations:
            - name: delegation
              serviceDelegation:
                name: NGINX.NGINXPLUS/nginxDeployments
                actions:
                  - Microsoft.Network/virtualNetworks/subnets/join/action
      exampleDeployment:
        type: azure:nginx:Deployment
        name: example
        properties:
          name: example-nginx
          resourceGroupName: ${example.name}
          sku: standardv2_Monthly
          location: ${example.location}
          managedResourceGroup: example
          diagnoseSupportEnabled: true
          automaticUpgradeChannel: stable
          frontendPublic:
            ipAddresses:
              - ${examplePublicIp.id}
          networkInterfaces:
            - subnetId: ${exampleSubnet.id}
          capacity: 20
          email: user@test.com
    

    Create Deployment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
    @overload
    def Deployment(resource_name: str,
                   args: DeploymentArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Deployment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   sku: Optional[str] = None,
                   location: Optional[str] = None,
                   logging_storage_accounts: Optional[Sequence[DeploymentLoggingStorageAccountArgs]] = None,
                   email: Optional[str] = None,
                   frontend_privates: Optional[Sequence[DeploymentFrontendPrivateArgs]] = None,
                   frontend_public: Optional[DeploymentFrontendPublicArgs] = None,
                   identity: Optional[DeploymentIdentityArgs] = None,
                   auto_scale_profiles: Optional[Sequence[DeploymentAutoScaleProfileArgs]] = None,
                   diagnose_support_enabled: Optional[bool] = None,
                   managed_resource_group: Optional[str] = None,
                   name: Optional[str] = None,
                   network_interfaces: Optional[Sequence[DeploymentNetworkInterfaceArgs]] = None,
                   capacity: Optional[int] = None,
                   automatic_upgrade_channel: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
    public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
    public Deployment(String name, DeploymentArgs args)
    public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
    
    type: azure:nginx:Deployment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureDeploymentResource = new Azure.Nginx.Deployment("azureDeploymentResource", new()
    {
        ResourceGroupName = "string",
        Sku = "string",
        Location = "string",
        LoggingStorageAccounts = new[]
        {
            new Azure.Nginx.Inputs.DeploymentLoggingStorageAccountArgs
            {
                ContainerName = "string",
                Name = "string",
            },
        },
        Email = "string",
        FrontendPrivates = new[]
        {
            new Azure.Nginx.Inputs.DeploymentFrontendPrivateArgs
            {
                AllocationMethod = "string",
                IpAddress = "string",
                SubnetId = "string",
            },
        },
        FrontendPublic = new Azure.Nginx.Inputs.DeploymentFrontendPublicArgs
        {
            IpAddresses = new[]
            {
                "string",
            },
        },
        Identity = new Azure.Nginx.Inputs.DeploymentIdentityArgs
        {
            Type = "string",
            IdentityIds = new[]
            {
                "string",
            },
            PrincipalId = "string",
            TenantId = "string",
        },
        AutoScaleProfiles = new[]
        {
            new Azure.Nginx.Inputs.DeploymentAutoScaleProfileArgs
            {
                MaxCapacity = 0,
                MinCapacity = 0,
                Name = "string",
            },
        },
        DiagnoseSupportEnabled = false,
        ManagedResourceGroup = "string",
        Name = "string",
        NetworkInterfaces = new[]
        {
            new Azure.Nginx.Inputs.DeploymentNetworkInterfaceArgs
            {
                SubnetId = "string",
            },
        },
        Capacity = 0,
        AutomaticUpgradeChannel = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := nginx.NewDeployment(ctx, "azureDeploymentResource", &nginx.DeploymentArgs{
    	ResourceGroupName: pulumi.String("string"),
    	Sku:               pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	LoggingStorageAccounts: nginx.DeploymentLoggingStorageAccountArray{
    		&nginx.DeploymentLoggingStorageAccountArgs{
    			ContainerName: pulumi.String("string"),
    			Name:          pulumi.String("string"),
    		},
    	},
    	Email: pulumi.String("string"),
    	FrontendPrivates: nginx.DeploymentFrontendPrivateArray{
    		&nginx.DeploymentFrontendPrivateArgs{
    			AllocationMethod: pulumi.String("string"),
    			IpAddress:        pulumi.String("string"),
    			SubnetId:         pulumi.String("string"),
    		},
    	},
    	FrontendPublic: &nginx.DeploymentFrontendPublicArgs{
    		IpAddresses: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Identity: &nginx.DeploymentIdentityArgs{
    		Type: pulumi.String("string"),
    		IdentityIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrincipalId: pulumi.String("string"),
    		TenantId:    pulumi.String("string"),
    	},
    	AutoScaleProfiles: nginx.DeploymentAutoScaleProfileArray{
    		&nginx.DeploymentAutoScaleProfileArgs{
    			MaxCapacity: pulumi.Int(0),
    			MinCapacity: pulumi.Int(0),
    			Name:        pulumi.String("string"),
    		},
    	},
    	DiagnoseSupportEnabled: pulumi.Bool(false),
    	ManagedResourceGroup:   pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	NetworkInterfaces: nginx.DeploymentNetworkInterfaceArray{
    		&nginx.DeploymentNetworkInterfaceArgs{
    			SubnetId: pulumi.String("string"),
    		},
    	},
    	Capacity:                pulumi.Int(0),
    	AutomaticUpgradeChannel: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var azureDeploymentResource = new Deployment("azureDeploymentResource", DeploymentArgs.builder()
        .resourceGroupName("string")
        .sku("string")
        .location("string")
        .loggingStorageAccounts(DeploymentLoggingStorageAccountArgs.builder()
            .containerName("string")
            .name("string")
            .build())
        .email("string")
        .frontendPrivates(DeploymentFrontendPrivateArgs.builder()
            .allocationMethod("string")
            .ipAddress("string")
            .subnetId("string")
            .build())
        .frontendPublic(DeploymentFrontendPublicArgs.builder()
            .ipAddresses("string")
            .build())
        .identity(DeploymentIdentityArgs.builder()
            .type("string")
            .identityIds("string")
            .principalId("string")
            .tenantId("string")
            .build())
        .autoScaleProfiles(DeploymentAutoScaleProfileArgs.builder()
            .maxCapacity(0)
            .minCapacity(0)
            .name("string")
            .build())
        .diagnoseSupportEnabled(false)
        .managedResourceGroup("string")
        .name("string")
        .networkInterfaces(DeploymentNetworkInterfaceArgs.builder()
            .subnetId("string")
            .build())
        .capacity(0)
        .automaticUpgradeChannel("string")
        .tags(Map.of("string", "string"))
        .build());
    
    azure_deployment_resource = azure.nginx.Deployment("azureDeploymentResource",
        resource_group_name="string",
        sku="string",
        location="string",
        logging_storage_accounts=[{
            "container_name": "string",
            "name": "string",
        }],
        email="string",
        frontend_privates=[{
            "allocation_method": "string",
            "ip_address": "string",
            "subnet_id": "string",
        }],
        frontend_public={
            "ip_addresses": ["string"],
        },
        identity={
            "type": "string",
            "identity_ids": ["string"],
            "principal_id": "string",
            "tenant_id": "string",
        },
        auto_scale_profiles=[{
            "max_capacity": 0,
            "min_capacity": 0,
            "name": "string",
        }],
        diagnose_support_enabled=False,
        managed_resource_group="string",
        name="string",
        network_interfaces=[{
            "subnet_id": "string",
        }],
        capacity=0,
        automatic_upgrade_channel="string",
        tags={
            "string": "string",
        })
    
    const azureDeploymentResource = new azure.nginx.Deployment("azureDeploymentResource", {
        resourceGroupName: "string",
        sku: "string",
        location: "string",
        loggingStorageAccounts: [{
            containerName: "string",
            name: "string",
        }],
        email: "string",
        frontendPrivates: [{
            allocationMethod: "string",
            ipAddress: "string",
            subnetId: "string",
        }],
        frontendPublic: {
            ipAddresses: ["string"],
        },
        identity: {
            type: "string",
            identityIds: ["string"],
            principalId: "string",
            tenantId: "string",
        },
        autoScaleProfiles: [{
            maxCapacity: 0,
            minCapacity: 0,
            name: "string",
        }],
        diagnoseSupportEnabled: false,
        managedResourceGroup: "string",
        name: "string",
        networkInterfaces: [{
            subnetId: "string",
        }],
        capacity: 0,
        automaticUpgradeChannel: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:nginx:Deployment
    properties:
        autoScaleProfiles:
            - maxCapacity: 0
              minCapacity: 0
              name: string
        automaticUpgradeChannel: string
        capacity: 0
        diagnoseSupportEnabled: false
        email: string
        frontendPrivates:
            - allocationMethod: string
              ipAddress: string
              subnetId: string
        frontendPublic:
            ipAddresses:
                - string
        identity:
            identityIds:
                - string
            principalId: string
            tenantId: string
            type: string
        location: string
        loggingStorageAccounts:
            - containerName: string
              name: string
        managedResourceGroup: string
        name: string
        networkInterfaces:
            - subnetId: string
        resourceGroupName: string
        sku: string
        tags:
            string: string
    

    Deployment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Deployment resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    Sku string
    AutoScaleProfiles List<DeploymentAutoScaleProfile>
    An auto_scale_profile block as defined below.
    AutomaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    Capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    DiagnoseSupportEnabled bool
    Should the metrics be exported to Azure Monitor?
    Email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    FrontendPrivates List<DeploymentFrontendPrivate>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    FrontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    Identity DeploymentIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    LoggingStorageAccounts List<DeploymentLoggingStorageAccount>
    One or more logging_storage_account blocks as defined below.
    ManagedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    Name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    NetworkInterfaces List<DeploymentNetworkInterface>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the NGINX Deployment.
    ResourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    Sku string
    AutoScaleProfiles []DeploymentAutoScaleProfileArgs
    An auto_scale_profile block as defined below.
    AutomaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    Capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    DiagnoseSupportEnabled bool
    Should the metrics be exported to Azure Monitor?
    Email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    FrontendPrivates []DeploymentFrontendPrivateArgs
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    FrontendPublic DeploymentFrontendPublicArgs
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    Identity DeploymentIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    LoggingStorageAccounts []DeploymentLoggingStorageAccountArgs
    One or more logging_storage_account blocks as defined below.
    ManagedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    Name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    NetworkInterfaces []DeploymentNetworkInterfaceArgs
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the NGINX Deployment.
    resourceGroupName String
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku String
    autoScaleProfiles List<DeploymentAutoScaleProfile>
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel String
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity Integer

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled Boolean
    Should the metrics be exported to Azure Monitor?
    email String
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates List<DeploymentFrontendPrivate>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentity
    An identity block as defined below.
    location String
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts List<DeploymentLoggingStorageAccount>
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup String
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name String
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces List<DeploymentNetworkInterface>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the NGINX Deployment.
    resourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku string
    autoScaleProfiles DeploymentAutoScaleProfile[]
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity number

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled boolean
    Should the metrics be exported to Azure Monitor?
    email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates DeploymentFrontendPrivate[]
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentity
    An identity block as defined below.
    location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts DeploymentLoggingStorageAccount[]
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces DeploymentNetworkInterface[]
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the NGINX Deployment.
    resource_group_name str
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku str
    auto_scale_profiles Sequence[DeploymentAutoScaleProfileArgs]
    An auto_scale_profile block as defined below.
    automatic_upgrade_channel str
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnose_support_enabled bool
    Should the metrics be exported to Azure Monitor?
    email str
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontend_privates Sequence[DeploymentFrontendPrivateArgs]
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontend_public DeploymentFrontendPublicArgs
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    logging_storage_accounts Sequence[DeploymentLoggingStorageAccountArgs]
    One or more logging_storage_account blocks as defined below.
    managed_resource_group str
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name str
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    network_interfaces Sequence[DeploymentNetworkInterfaceArgs]
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the NGINX Deployment.
    resourceGroupName String
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku String
    autoScaleProfiles List<Property Map>
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel String
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity Number

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled Boolean
    Should the metrics be exported to Azure Monitor?
    email String
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates List<Property Map>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic Property Map
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts List<Property Map>
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup String
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name String
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces List<Property Map>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the NGINX Deployment.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the deployment.
    NginxVersion string
    The version of deployed NGINX.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the deployment.
    NginxVersion string
    The version of deployed NGINX.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the deployment.
    nginxVersion String
    The version of deployed NGINX.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The IP address of the deployment.
    nginxVersion string
    The version of deployed NGINX.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The IP address of the deployment.
    nginx_version str
    The version of deployed NGINX.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the deployment.
    nginxVersion String
    The version of deployed NGINX.

    Look up Existing Deployment Resource

    Get an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_scale_profiles: Optional[Sequence[DeploymentAutoScaleProfileArgs]] = None,
            automatic_upgrade_channel: Optional[str] = None,
            capacity: Optional[int] = None,
            diagnose_support_enabled: Optional[bool] = None,
            email: Optional[str] = None,
            frontend_privates: Optional[Sequence[DeploymentFrontendPrivateArgs]] = None,
            frontend_public: Optional[DeploymentFrontendPublicArgs] = None,
            identity: Optional[DeploymentIdentityArgs] = None,
            ip_address: Optional[str] = None,
            location: Optional[str] = None,
            logging_storage_accounts: Optional[Sequence[DeploymentLoggingStorageAccountArgs]] = None,
            managed_resource_group: Optional[str] = None,
            name: Optional[str] = None,
            network_interfaces: Optional[Sequence[DeploymentNetworkInterfaceArgs]] = None,
            nginx_version: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Deployment
    func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
    public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
    public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoScaleProfiles List<DeploymentAutoScaleProfile>
    An auto_scale_profile block as defined below.
    AutomaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    Capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    DiagnoseSupportEnabled bool
    Should the metrics be exported to Azure Monitor?
    Email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    FrontendPrivates List<DeploymentFrontendPrivate>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    FrontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    Identity DeploymentIdentity
    An identity block as defined below.
    IpAddress string
    The IP address of the deployment.
    Location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    LoggingStorageAccounts List<DeploymentLoggingStorageAccount>
    One or more logging_storage_account blocks as defined below.
    ManagedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    Name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    NetworkInterfaces List<DeploymentNetworkInterface>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    NginxVersion string
    The version of deployed NGINX.
    ResourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    Sku string
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the NGINX Deployment.
    AutoScaleProfiles []DeploymentAutoScaleProfileArgs
    An auto_scale_profile block as defined below.
    AutomaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    Capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    DiagnoseSupportEnabled bool
    Should the metrics be exported to Azure Monitor?
    Email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    FrontendPrivates []DeploymentFrontendPrivateArgs
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    FrontendPublic DeploymentFrontendPublicArgs
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    Identity DeploymentIdentityArgs
    An identity block as defined below.
    IpAddress string
    The IP address of the deployment.
    Location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    LoggingStorageAccounts []DeploymentLoggingStorageAccountArgs
    One or more logging_storage_account blocks as defined below.
    ManagedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    Name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    NetworkInterfaces []DeploymentNetworkInterfaceArgs
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    NginxVersion string
    The version of deployed NGINX.
    ResourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    Sku string
    Tags map[string]string
    A mapping of tags which should be assigned to the NGINX Deployment.
    autoScaleProfiles List<DeploymentAutoScaleProfile>
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel String
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity Integer

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled Boolean
    Should the metrics be exported to Azure Monitor?
    email String
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates List<DeploymentFrontendPrivate>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentity
    An identity block as defined below.
    ipAddress String
    The IP address of the deployment.
    location String
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts List<DeploymentLoggingStorageAccount>
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup String
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name String
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces List<DeploymentNetworkInterface>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    nginxVersion String
    The version of deployed NGINX.
    resourceGroupName String
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku String
    tags Map<String,String>
    A mapping of tags which should be assigned to the NGINX Deployment.
    autoScaleProfiles DeploymentAutoScaleProfile[]
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel string
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity number

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled boolean
    Should the metrics be exported to Azure Monitor?
    email string
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates DeploymentFrontendPrivate[]
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic DeploymentFrontendPublic
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentity
    An identity block as defined below.
    ipAddress string
    The IP address of the deployment.
    location string
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts DeploymentLoggingStorageAccount[]
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup string
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name string
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces DeploymentNetworkInterface[]
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    nginxVersion string
    The version of deployed NGINX.
    resourceGroupName string
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku string
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the NGINX Deployment.
    auto_scale_profiles Sequence[DeploymentAutoScaleProfileArgs]
    An auto_scale_profile block as defined below.
    automatic_upgrade_channel str
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity int

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnose_support_enabled bool
    Should the metrics be exported to Azure Monitor?
    email str
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontend_privates Sequence[DeploymentFrontendPrivateArgs]
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontend_public DeploymentFrontendPublicArgs
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity DeploymentIdentityArgs
    An identity block as defined below.
    ip_address str
    The IP address of the deployment.
    location str
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    logging_storage_accounts Sequence[DeploymentLoggingStorageAccountArgs]
    One or more logging_storage_account blocks as defined below.
    managed_resource_group str
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name str
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    network_interfaces Sequence[DeploymentNetworkInterfaceArgs]
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    nginx_version str
    The version of deployed NGINX.
    resource_group_name str
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku str
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the NGINX Deployment.
    autoScaleProfiles List<Property Map>
    An auto_scale_profile block as defined below.
    automaticUpgradeChannel String
    Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.
    capacity Number

    Specify the number of NGINX capacity units for this NGINX deployment.

    Note For more information on NGINX capacity units, please refer to the NGINX scaling guidance documentation

    diagnoseSupportEnabled Boolean
    Should the metrics be exported to Azure Monitor?
    email String
    Specify the preferred support contact email address for receiving alerts and notifications.
    frontendPrivates List<Property Map>
    One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    frontendPublic Property Map
    A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.
    identity Property Map
    An identity block as defined below.
    ipAddress String
    The IP address of the deployment.
    location String
    The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    loggingStorageAccounts List<Property Map>
    One or more logging_storage_account blocks as defined below.
    managedResourceGroup String
    Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.
    name String
    The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    networkInterfaces List<Property Map>
    One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.
    nginxVersion String
    The version of deployed NGINX.
    resourceGroupName String
    The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.
    sku String
    tags Map<String>
    A mapping of tags which should be assigned to the NGINX Deployment.

    Supporting Types

    DeploymentAutoScaleProfile, DeploymentAutoScaleProfileArgs

    MaxCapacity int
    MinCapacity int
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    Name string
    Specify the name of the autoscaling profile.
    MaxCapacity int
    MinCapacity int
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    Name string
    Specify the name of the autoscaling profile.
    maxCapacity Integer
    minCapacity Integer
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    name String
    Specify the name of the autoscaling profile.
    maxCapacity number
    minCapacity number
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    name string
    Specify the name of the autoscaling profile.
    max_capacity int
    min_capacity int
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    name str
    Specify the name of the autoscaling profile.
    maxCapacity Number
    minCapacity Number
    Specify the minimum number of NGINX capacity units for this NGINX Deployment.
    name String
    Specify the name of the autoscaling profile.

    DeploymentFrontendPrivate, DeploymentFrontendPrivateArgs

    AllocationMethod string
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    IpAddress string
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    SubnetId string
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    AllocationMethod string
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    IpAddress string
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    SubnetId string
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    allocationMethod String
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    ipAddress String
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    subnetId String
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    allocationMethod string
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    ipAddress string
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    subnetId string
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    allocation_method str
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    ip_address str
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    subnet_id str
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    allocationMethod String
    Specify the method for allocating the private IP. Possible values are Static and Dynamic. Changing this forces a new NGINX Deployment to be created.
    ipAddress String
    Specify the private IP Address. Changing this forces a new NGINX Deployment to be created.
    subnetId String
    Specify the Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.

    DeploymentFrontendPublic, DeploymentFrontendPublicArgs

    IpAddresses List<string>
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    IpAddresses []string
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    ipAddresses List<String>
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    ipAddresses string[]
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    ip_addresses Sequence[str]
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    ipAddresses List<String>
    Specifies a list of Public IP Resource ID to this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.

    DeploymentIdentity, DeploymentIdentityArgs

    Type string
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    IdentityIds List<string>

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    PrincipalId string
    TenantId string
    Type string
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    IdentityIds []string

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    PrincipalId string
    TenantId string
    type String
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    principalId String
    tenantId String
    type string
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    identityIds string[]

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    principalId string
    tenantId string
    type str
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    identity_ids Sequence[str]

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    principal_id str
    tenant_id str
    type String
    Specifies the identity type of the NGINX Deployment. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of user managed identity ids to be assigned.

    NOTE: This is required when type is set to UserAssigned.

    principalId String
    tenantId String

    DeploymentLoggingStorageAccount, DeploymentLoggingStorageAccountArgs

    ContainerName string
    Specify the container name in the Storage Account for logging.
    Name string
    The name of the StorageAccount for NGINX Logging.
    ContainerName string
    Specify the container name in the Storage Account for logging.
    Name string
    The name of the StorageAccount for NGINX Logging.
    containerName String
    Specify the container name in the Storage Account for logging.
    name String
    The name of the StorageAccount for NGINX Logging.
    containerName string
    Specify the container name in the Storage Account for logging.
    name string
    The name of the StorageAccount for NGINX Logging.
    container_name str
    Specify the container name in the Storage Account for logging.
    name str
    The name of the StorageAccount for NGINX Logging.
    containerName String
    Specify the container name in the Storage Account for logging.
    name String
    The name of the StorageAccount for NGINX Logging.

    DeploymentNetworkInterface, DeploymentNetworkInterfaceArgs

    SubnetId string
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    SubnetId string
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    subnetId String
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    subnetId string
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    subnet_id str
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.
    subnetId String
    Specify The Subnet Resource ID for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.

    Import

    NGINX Deployments can be imported using the resource id, e.g.

    $ pulumi import azure:nginx/deployment:Deployment example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Nginx.NginxPlus/nginxDeployments/dep1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi