import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an NGINX Deployment. * * ## Example Usage * * ```typescript * 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: "standardv3_Monthly", * location: example.location, * automaticUpgradeChannel: "stable", * frontendPublic: { * ipAddresses: [examplePublicIp.id], * }, * networkInterfaces: [{ * subnetId: exampleSubnet.id, * }], * capacity: 20, * email: "user@test.com", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Nginx.NginxPlus` - 2024-11-01-preview * * ## Import * * NGINX Deployments can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:nginx/deployment:Deployment example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Nginx.NginxPlus/nginxDeployments/dep1 * ``` */ export declare class Deployment extends pulumi.CustomResource { /** * Get an existing Deployment resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DeploymentState, opts?: pulumi.CustomResourceOptions): Deployment; /** * Returns true if the given object is an instance of Deployment. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Deployment; /** * An `autoScaleProfile` block as defined below. */ readonly autoScaleProfiles: pulumi.Output; /** * Specify the automatic upgrade channel for the NGINX deployment. Defaults to `stable`. The possible values are `stable` and `preview`. */ readonly automaticUpgradeChannel: pulumi.Output; /** * 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](https://docs.nginx.com/nginxaas/azure/quickstart/scaling/) */ readonly capacity: pulumi.Output; /** * The dataplane API endpoint of the NGINX Deployment. */ readonly dataplaneApiEndpoint: pulumi.Output; /** * @deprecated this property is deprecated and will be removed in v5.0, metrics are enabled by default. */ readonly diagnoseSupportEnabled: pulumi.Output; /** * Specify the preferred support contact email address for receiving alerts and notifications. */ readonly email: pulumi.Output; /** * One or more `frontendPrivate` blocks as defined below. */ readonly frontendPrivates: pulumi.Output; /** * A `frontendPublic` block as defined below. */ readonly frontendPublic: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * The IP address of the NGINX Deployment. */ readonly ipAddress: pulumi.Output; /** * The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ readonly location: pulumi.Output; /** * @deprecated The `loggingStorageAccount` block has been deprecated and will be removed in v5.0 of the AzureRM Provider. To enable logs, use the `azure.monitoring.DiagnosticSetting` resource instead. */ readonly loggingStorageAccounts: pulumi.Output; /** * @deprecated The `managedResourceGroup` field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider. */ readonly managedResourceGroup: pulumi.Output; /** * The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created. */ readonly name: pulumi.Output; /** * One or more `networkInterface` blocks as defined below. */ readonly networkInterfaces: pulumi.Output; /** * The version of the NGINX Deployment. */ readonly nginxVersion: pulumi.Output; /** * The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ readonly resourceGroupName: pulumi.Output; /** * Specifies the NGINX Deployment SKU. * * > **Note:** For a list of available SKUs, please reference the [NGINXaaS for Azure documentation](https://docs.nginx.com/nginxaas/azure/billing/overview) * * > **Note:** If you are setting the `sku` to `basic_Monthly`, you cannot specify a `capacity` or `autoScaleProfile`; basic plans do not support scaling. Other `sku`s require either `capacity` or `autoScaleProfile`. If you're using `basic_Monthly` with deployments created before v4.0, you may need to use Terraform's `ignoreChanges` functionality to ignore changes to the `capacity` field. */ readonly sku: pulumi.Output; /** * A mapping of tags which should be assigned to the NGINX Deployment. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A `webApplicationFirewall` blocks as defined below. */ readonly webApplicationFirewall: pulumi.Output; /** * Create a Deployment resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DeploymentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Deployment resources. */ export interface DeploymentState { /** * An `autoScaleProfile` block as defined below. */ autoScaleProfiles?: pulumi.Input[]>; /** * Specify the automatic upgrade channel for the NGINX deployment. Defaults to `stable`. The possible values are `stable` and `preview`. */ automaticUpgradeChannel?: pulumi.Input; /** * 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](https://docs.nginx.com/nginxaas/azure/quickstart/scaling/) */ capacity?: pulumi.Input; /** * The dataplane API endpoint of the NGINX Deployment. */ dataplaneApiEndpoint?: pulumi.Input; /** * @deprecated this property is deprecated and will be removed in v5.0, metrics are enabled by default. */ diagnoseSupportEnabled?: pulumi.Input; /** * Specify the preferred support contact email address for receiving alerts and notifications. */ email?: pulumi.Input; /** * One or more `frontendPrivate` blocks as defined below. */ frontendPrivates?: pulumi.Input[]>; /** * A `frontendPublic` block as defined below. */ frontendPublic?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The IP address of the NGINX Deployment. */ ipAddress?: pulumi.Input; /** * The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ location?: pulumi.Input; /** * @deprecated The `loggingStorageAccount` block has been deprecated and will be removed in v5.0 of the AzureRM Provider. To enable logs, use the `azure.monitoring.DiagnosticSetting` resource instead. */ loggingStorageAccounts?: pulumi.Input[]>; /** * @deprecated The `managedResourceGroup` field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider. */ managedResourceGroup?: pulumi.Input; /** * The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created. */ name?: pulumi.Input; /** * One or more `networkInterface` blocks as defined below. */ networkInterfaces?: pulumi.Input[]>; /** * The version of the NGINX Deployment. */ nginxVersion?: pulumi.Input; /** * The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ resourceGroupName?: pulumi.Input; /** * Specifies the NGINX Deployment SKU. * * > **Note:** For a list of available SKUs, please reference the [NGINXaaS for Azure documentation](https://docs.nginx.com/nginxaas/azure/billing/overview) * * > **Note:** If you are setting the `sku` to `basic_Monthly`, you cannot specify a `capacity` or `autoScaleProfile`; basic plans do not support scaling. Other `sku`s require either `capacity` or `autoScaleProfile`. If you're using `basic_Monthly` with deployments created before v4.0, you may need to use Terraform's `ignoreChanges` functionality to ignore changes to the `capacity` field. */ sku?: pulumi.Input; /** * A mapping of tags which should be assigned to the NGINX Deployment. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `webApplicationFirewall` blocks as defined below. */ webApplicationFirewall?: pulumi.Input; } /** * The set of arguments for constructing a Deployment resource. */ export interface DeploymentArgs { /** * An `autoScaleProfile` block as defined below. */ autoScaleProfiles?: pulumi.Input[]>; /** * Specify the automatic upgrade channel for the NGINX deployment. Defaults to `stable`. The possible values are `stable` and `preview`. */ automaticUpgradeChannel?: pulumi.Input; /** * 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](https://docs.nginx.com/nginxaas/azure/quickstart/scaling/) */ capacity?: pulumi.Input; /** * @deprecated this property is deprecated and will be removed in v5.0, metrics are enabled by default. */ diagnoseSupportEnabled?: pulumi.Input; /** * Specify the preferred support contact email address for receiving alerts and notifications. */ email?: pulumi.Input; /** * One or more `frontendPrivate` blocks as defined below. */ frontendPrivates?: pulumi.Input[]>; /** * A `frontendPublic` block as defined below. */ frontendPublic?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The Azure Region where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ location?: pulumi.Input; /** * @deprecated The `loggingStorageAccount` block has been deprecated and will be removed in v5.0 of the AzureRM Provider. To enable logs, use the `azure.monitoring.DiagnosticSetting` resource instead. */ loggingStorageAccounts?: pulumi.Input[]>; /** * @deprecated The `managedResourceGroup` field isn't supported by the API anymore and has been deprecated and will be removed in v5.0 of the AzureRM Provider. */ managedResourceGroup?: pulumi.Input; /** * The name which should be used for this NGINX Deployment. Changing this forces a new NGINX Deployment to be created. */ name?: pulumi.Input; /** * One or more `networkInterface` blocks as defined below. */ networkInterfaces?: pulumi.Input[]>; /** * The name of the Resource Group where the NGINX Deployment should exist. Changing this forces a new NGINX Deployment to be created. */ resourceGroupName: pulumi.Input; /** * Specifies the NGINX Deployment SKU. * * > **Note:** For a list of available SKUs, please reference the [NGINXaaS for Azure documentation](https://docs.nginx.com/nginxaas/azure/billing/overview) * * > **Note:** If you are setting the `sku` to `basic_Monthly`, you cannot specify a `capacity` or `autoScaleProfile`; basic plans do not support scaling. Other `sku`s require either `capacity` or `autoScaleProfile`. If you're using `basic_Monthly` with deployments created before v4.0, you may need to use Terraform's `ignoreChanges` functionality to ignore changes to the `capacity` field. */ sku: pulumi.Input; /** * A mapping of tags which should be assigned to the NGINX Deployment. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `webApplicationFirewall` blocks as defined below. */ webApplicationFirewall?: pulumi.Input; }