Deployment

class Deployment : KotlinCustomResource

Manages an NGINX Deployment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";
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 configContent = std.base64encode({
input: `http {
server {
listen 80;
location / {
auth_basic "Protected Area";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
`,
}).then(invoke => invoke.result);
const protectedContent = std.base64encode({
input: "user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1\n",
}).then(invoke => invoke.result);
const subConfigContent = std.base64encode({
input: `location /bbb {
\x09default_type text/html;
\x09return 200 '<!doctype html><html lang="en"><head></head><body>
\x09\x09<div>this one will be updated</div>
\x09\x09<div>at 10:38 am</div>
\x09</body></html>';
}
`,
}).then(invoke => invoke.result);
const exampleDeployment = new azure.nginx.Deployment("example", {
name: "example-nginx",
resourceGroupName: example.name,
sku: "publicpreview_Monthly_gmz7xq9ge3py",
location: example.location,
managedResourceGroup: "example",
diagnoseSupportEnabled: true,
automaticUpgradeChannel: "stable",
frontendPublic: {
ipAddresses: [examplePublicIp&#46;id],
},
networkInterfaces: [{
subnetId: exampleSubnet.id,
}],
capacity: 20,
email: "user@test.com",
configuration: {
rootFile: "/etc/nginx/nginx.conf",
configFiles: [
{
content: configContent,
virtualPath: "/etc/nginx/nginx.conf",
},
{
content: subConfigContent,
virtualPath: "/etc/nginx/site/b.conf",
},
],
protectedFiles: [{
content: protectedContent,
virtualPath: "/opt/.htpasswd",
}],
},
});
import pulumi
import pulumi_azure as azure
import pulumi_std as std
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&#46;0&#46;0&#46;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&#46;0&#46;2&#46;0/24"],
delegations=[azure.network.SubnetDelegationArgs(
name="delegation",
service_delegation=azure.network.SubnetDelegationServiceDelegationArgs(
name="NGINX.NGINXPLUS/nginxDeployments",
actions=["Microsoft&#46;Network/virtualNetworks/subnets/join/action"],
),
)])
config_content = std.base64encode(input="""http {
server {
listen 80;
location / {
auth_basic "Protected Area";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
""").result
protected_content = std.base64encode(input="user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1\n").result
sub_config_content = std.base64encode(input="""location /bbb {
\x09default_type text/html;
\x09return 200 '<!doctype html><html lang="en"><head></head><body>
\x09\x09<div>this one will be updated</div>
\x09\x09<div>at 10:38 am</div>
\x09</body></html>';
}
""").result
example_deployment = azure.nginx.Deployment("example",
name="example-nginx",
resource_group_name=example.name,
sku="publicpreview_Monthly_gmz7xq9ge3py",
location=example.location,
managed_resource_group="example",
diagnose_support_enabled=True,
automatic_upgrade_channel="stable",
frontend_public=azure.nginx.DeploymentFrontendPublicArgs(
ip_addresses=[example_public_ip&#46;id],
),
network_interfaces=[azure.nginx.DeploymentNetworkInterfaceArgs(
subnet_id=example_subnet.id,
)],
capacity=20,
email="user@test.com",
configuration=azure.nginx.DeploymentConfigurationArgs(
root_file="/etc/nginx/nginx.conf",
config_files=[
azure.nginx.DeploymentConfigurationConfigFileArgs(
content=config_content,
virtual_path="/etc/nginx/nginx.conf",
),
azure.nginx.DeploymentConfigurationConfigFileArgs(
content=sub_config_content,
virtual_path="/etc/nginx/site/b.conf",
),
],
protected_files=[azure.nginx.DeploymentConfigurationProtectedFileArgs(
content=protected_content,
virtual_path="/opt/.htpasswd",
)],
))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;
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 configContent = Std.Base64encode.Invoke(new()
{
Input = @"http {
server {
listen 80;
location / {
auth_basic ""Protected Area"";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
",
}).Apply(invoke => invoke.Result);
var protectedContent = Std.Base64encode.Invoke(new()
{
Input = @"user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1
",
}).Apply(invoke => invoke.Result);
var subConfigContent = Std.Base64encode.Invoke(new()
{
Input = @"location /bbb {
default_type text/html;
return 200 '<!doctype html><html lang=""en""><head></head><body>
<div>this one will be updated</div>
<div>at 10:38 am</div>
</body></html>';
}
",
}).Apply(invoke => invoke.Result);
var exampleDeployment = new Azure.Nginx.Deployment("example", new()
{
Name = "example-nginx",
ResourceGroupName = example.Name,
Sku = "publicpreview_Monthly_gmz7xq9ge3py",
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",
Configuration = new Azure.Nginx.Inputs.DeploymentConfigurationArgs
{
RootFile = "/etc/nginx/nginx.conf",
ConfigFiles = new[]
{
new Azure.Nginx.Inputs.DeploymentConfigurationConfigFileArgs
{
Content = configContent,
VirtualPath = "/etc/nginx/nginx.conf",
},
new Azure.Nginx.Inputs.DeploymentConfigurationConfigFileArgs
{
Content = subConfigContent,
VirtualPath = "/etc/nginx/site/b.conf",
},
},
ProtectedFiles = new[]
{
new Azure.Nginx.Inputs.DeploymentConfigurationProtectedFileArgs
{
Content = protectedContent,
VirtualPath = "/opt/.htpasswd",
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/nginx"
"github.com/pulumi/pulumi-std/sdk/go/std"
"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
}
configContent := std.Base64encode(ctx, &std.Base64encodeArgs{
Input: `http {
server {
listen 80;
location / {
auth_basic "Protected Area";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
`,
}, nil).Result
protectedContent := std.Base64encode(ctx, &std.Base64encodeArgs{
Input: "user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1\n",
}, nil).Result
subConfigContent := std.Base64encode(ctx, &std.Base64encodeArgs{
Input: `location /bbb {
default_type text/html;
return 200 '<!doctype html><html lang="en"><head></head><body>
<div>this one will be updated</div>
<div>at 10:38 am</div>
</body></html>';
}
`,
}, nil).Result
_, err = nginx.NewDeployment(ctx, "example", &nginx.DeploymentArgs{
Name: pulumi.String("example-nginx"),
ResourceGroupName: example.Name,
Sku: pulumi.String("publicpreview_Monthly_gmz7xq9ge3py"),
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"),
Configuration: &nginx.DeploymentConfigurationArgs{
RootFile: pulumi.String("/etc/nginx/nginx.conf"),
ConfigFiles: nginx.DeploymentConfigurationConfigFileArray{
&nginx.DeploymentConfigurationConfigFileArgs{
Content: pulumi.String(configContent),
VirtualPath: pulumi.String("/etc/nginx/nginx.conf"),
},
&nginx.DeploymentConfigurationConfigFileArgs{
Content: pulumi.String(subConfigContent),
VirtualPath: pulumi.String("/etc/nginx/site/b.conf"),
},
},
ProtectedFiles: nginx.DeploymentConfigurationProtectedFileArray{
&nginx.DeploymentConfigurationProtectedFileArgs{
Content: pulumi.String(protectedContent),
VirtualPath: pulumi.String("/opt/.htpasswd"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.azure.nginx.inputs.DeploymentConfigurationArgs;
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());
final var configContent = StdFunctions.base64encode(Base64encodeArgs.builder()
.input("""
http {
server {
listen 80;
location / {
auth_basic "Protected Area";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
""")
.build()).result();
final var protectedContent = StdFunctions.base64encode(Base64encodeArgs.builder()
.input("""
user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1
""")
.build()).result();
final var subConfigContent = StdFunctions.base64encode(Base64encodeArgs.builder()
.input("""
location /bbb {
default_type text/html;
return 200 '<!doctype html><html lang="en"><head></head><body>
<div>this one will be updated</div>
<div>at 10:38 am</div>
</body></html>';
}
""")
.build()).result();
var exampleDeployment = new Deployment("exampleDeployment", DeploymentArgs.builder()
.name("example-nginx")
.resourceGroupName(example.name())
.sku("publicpreview_Monthly_gmz7xq9ge3py")
.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")
.configuration(DeploymentConfigurationArgs.builder()
.rootFile("/etc/nginx/nginx.conf")
.configFiles(
DeploymentConfigurationConfigFileArgs.builder()
.content(configContent)
.virtualPath("/etc/nginx/nginx.conf")
.build(),
DeploymentConfigurationConfigFileArgs.builder()
.content(subConfigContent)
.virtualPath("/etc/nginx/site/b.conf")
.build())
.protectedFiles(DeploymentConfigurationProtectedFileArgs.builder()
.content(protectedContent)
.virtualPath("/opt/.htpasswd")
.build())
.build())
.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: publicpreview_Monthly_gmz7xq9ge3py
location: ${example.location}
managedResourceGroup: example
diagnoseSupportEnabled: true
automaticUpgradeChannel: stable
frontendPublic:
ipAddresses:
- ${examplePublicIp.id}
networkInterfaces:
- subnetId: ${exampleSubnet.id}
capacity: 20
email: user@test.com
configuration:
rootFile: /etc/nginx/nginx.conf
configFiles:
- content: ${configContent}
virtualPath: /etc/nginx/nginx.conf
- content: ${subConfigContent}
virtualPath: /etc/nginx/site/b.conf
protectedFiles:
- content: ${protectedContent}
virtualPath: /opt/.htpasswd
variables:
configContent:
fn::invoke:
Function: std:base64encode
Arguments:
input: |
http {
server {
listen 80;
location / {
auth_basic "Protected Area";
auth_basic_user_file /opt/.htpasswd;
default_type text/html;
}
include site/*.conf;
}
}
Return: result
protectedContent:
fn::invoke:
Function: std:base64encode
Arguments:
input: |
user:$apr1$VeUA5kt.$IjjRk//8miRxDsZvD4daF1
Return: result
subConfigContent:
fn::invoke:
Function: std:base64encode
Arguments:
input: |
location /bbb {
default_type text/html;
return 200 '<!doctype html><html lang="en"><head></head><body>
<div>this one will be updated</div>
<div>at 10:38 am</div>
</body></html>';
}
Return: result

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

//////

Properties

Link copied to clipboard

Specify the automatic upgrade channel for the NGINX deployment. Defaults to stable. The possible values are stable and preview.

Link copied to clipboard

An auto_scale_profile block as defined below.

Link copied to clipboard
val capacity: Output<Int>?

Specify the number of NGINX capacity units for this NGINX deployment. Defaults to 20.

Link copied to clipboard

Specify a custom configuration block as defined below.

Link copied to clipboard

Should the diagnosis support be enabled?

Link copied to clipboard
val email: Output<String>?

Specify the preferred support contact email address for receiving alerts and notifications.

Link copied to clipboard

One or more frontend_private blocks as defined below. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard

A frontend_public block as defined below. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An identity block as defined below.

Link copied to clipboard
val ipAddress: Output<String>

The IP address of the deployment.

Link copied to clipboard
val location: Output<String>

The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard

One or more logging_storage_account blocks as defined below.

Link copied to clipboard

Specify the managed resource group to deploy VNet injection related network resources. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard
val name: Output<String>

The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard

One or more network_interface blocks as defined below. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard
val nginxVersion: Output<String>

The version of deployed NGINX.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created.

Link copied to clipboard
val sku: Output<String>

Specifies the NGINX Deployment SKU. Possible values include standard_Monthly. Changing this forces a new resource to be created.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags which should be assigned to the NGINX Deployment.

Link copied to clipboard
val urn: Output<String>