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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

azure.nginx.Configuration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

    Manages the configuration for a Nginx Deployment.

    Create Configuration Resource

    new Configuration(name: string, args: ConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def Configuration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  config_files: Optional[Sequence[ConfigurationConfigFileArgs]] = None,
                  nginx_deployment_id: Optional[str] = None,
                  package_data: Optional[str] = None,
                  protected_files: Optional[Sequence[ConfigurationProtectedFileArgs]] = None,
                  root_file: Optional[str] = None)
@overload
def Configuration(resource_name: str,
                  args: ConfigurationArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewConfiguration(ctx *Context, name string, args ConfigurationArgs, opts ...ResourceOption) (*Configuration, error)
    public Configuration(string name, ConfigurationArgs args, CustomResourceOptions? opts = null)
    public Configuration(String name, ConfigurationArgs args)
public Configuration(String name, ConfigurationArgs args, CustomResourceOptions options)

    type: azure:nginx:Configuration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    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 ConfigurationArgs
    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 ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Configuration Resource Properties

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

    Inputs

    The Configuration resource accepts the following input properties:

    NginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    RootFile string

    Specify the root file path of this Nginx Configuration.

    ConfigFiles List<ConfigurationConfigFile>

    One or more config_file blocks as defined below.

    PackageData string

    Specify the package data for this configuration.

    ProtectedFiles List<ConfigurationProtectedFile>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    NginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    RootFile string

    Specify the root file path of this Nginx Configuration.

    ConfigFiles []ConfigurationConfigFileArgs

    One or more config_file blocks as defined below.

    PackageData string

    Specify the package data for this configuration.

    ProtectedFiles []ConfigurationProtectedFileArgs

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    nginxDeploymentId String

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    rootFile String

    Specify the root file path of this Nginx Configuration.

    configFiles List<ConfigurationConfigFile>

    One or more config_file blocks as defined below.

    packageData String

    Specify the package data for this configuration.

    protectedFiles List<ConfigurationProtectedFile>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    nginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    rootFile string

    Specify the root file path of this Nginx Configuration.

    configFiles ConfigurationConfigFile[]

    One or more config_file blocks as defined below.

    packageData string

    Specify the package data for this configuration.

    protectedFiles ConfigurationProtectedFile[]

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    nginx_deployment_id str

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    root_file str

    Specify the root file path of this Nginx Configuration.

    config_files Sequence[ConfigurationConfigFileArgs]

    One or more config_file blocks as defined below.

    package_data str

    Specify the package data for this configuration.

    protected_files Sequence[ConfigurationProtectedFileArgs]

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    nginxDeploymentId String

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    rootFile String

    Specify the root file path of this Nginx Configuration.

    configFiles List<Property Map>

    One or more config_file blocks as defined below.

    packageData String

    Specify the package data for this configuration.

    protectedFiles List<Property Map>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing Configuration Resource

    Get an existing Configuration 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?: ConfigurationState, opts?: CustomResourceOptions): Configuration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_files: Optional[Sequence[ConfigurationConfigFileArgs]] = None,
        nginx_deployment_id: Optional[str] = None,
        package_data: Optional[str] = None,
        protected_files: Optional[Sequence[ConfigurationProtectedFileArgs]] = None,
        root_file: Optional[str] = None) -> Configuration
    func GetConfiguration(ctx *Context, name string, id IDInput, state *ConfigurationState, opts ...ResourceOption) (*Configuration, error)
    public static Configuration Get(string name, Input<string> id, ConfigurationState? state, CustomResourceOptions? opts = null)
    public static Configuration get(String name, Output<String> id, ConfigurationState 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:
    ConfigFiles List<ConfigurationConfigFile>

    One or more config_file blocks as defined below.

    NginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    PackageData string

    Specify the package data for this configuration.

    ProtectedFiles List<ConfigurationProtectedFile>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    RootFile string

    Specify the root file path of this Nginx Configuration.

    ConfigFiles []ConfigurationConfigFileArgs

    One or more config_file blocks as defined below.

    NginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    PackageData string

    Specify the package data for this configuration.

    ProtectedFiles []ConfigurationProtectedFileArgs

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    RootFile string

    Specify the root file path of this Nginx Configuration.

    configFiles List<ConfigurationConfigFile>

    One or more config_file blocks as defined below.

    nginxDeploymentId String

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    packageData String

    Specify the package data for this configuration.

    protectedFiles List<ConfigurationProtectedFile>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    rootFile String

    Specify the root file path of this Nginx Configuration.

    configFiles ConfigurationConfigFile[]

    One or more config_file blocks as defined below.

    nginxDeploymentId string

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    packageData string

    Specify the package data for this configuration.

    protectedFiles ConfigurationProtectedFile[]

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    rootFile string

    Specify the root file path of this Nginx Configuration.

    config_files Sequence[ConfigurationConfigFileArgs]

    One or more config_file blocks as defined below.

    nginx_deployment_id str

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    package_data str

    Specify the package data for this configuration.

    protected_files Sequence[ConfigurationProtectedFileArgs]

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    root_file str

    Specify the root file path of this Nginx Configuration.

    configFiles List<Property Map>

    One or more config_file blocks as defined below.

    nginxDeploymentId String

    The ID of the Nginx Deployment. Changing this forces a new Nginx Configuration to be created.

    packageData String

    Specify the package data for this configuration.

    protectedFiles List<Property Map>

    One or more protected_file (Protected File) blocks with sensitive information as defined below. If specified config_file must also be specified.

    rootFile String

    Specify the root file path of this Nginx Configuration.

    Supporting Types

    ConfigurationConfigFile, ConfigurationConfigFileArgs

    Content string

    Specifies the base-64 encoded contents of this config file.

    VirtualPath string

    Specify the path of this config file.

    Content string

    Specifies the base-64 encoded contents of this config file.

    VirtualPath string

    Specify the path of this config file.

    content String

    Specifies the base-64 encoded contents of this config file.

    virtualPath String

    Specify the path of this config file.

    content string

    Specifies the base-64 encoded contents of this config file.

    virtualPath string

    Specify the path of this config file.

    content str

    Specifies the base-64 encoded contents of this config file.

    virtual_path str

    Specify the path of this config file.

    content String

    Specifies the base-64 encoded contents of this config file.

    virtualPath String

    Specify the path of this config file.

    ConfigurationProtectedFile, ConfigurationProtectedFileArgs

    Content string

    Specifies the base-64 encoded contents of this config file (Sensitive).

    VirtualPath string

    Specify the path of this config file.

    Content string

    Specifies the base-64 encoded contents of this config file (Sensitive).

    VirtualPath string

    Specify the path of this config file.

    content String

    Specifies the base-64 encoded contents of this config file (Sensitive).

    virtualPath String

    Specify the path of this config file.

    content string

    Specifies the base-64 encoded contents of this config file (Sensitive).

    virtualPath string

    Specify the path of this config file.

    content str

    Specifies the base-64 encoded contents of this config file (Sensitive).

    virtual_path str

    Specify the path of this config file.

    content String

    Specifies the base-64 encoded contents of this config file (Sensitive).

    virtualPath String

    Specify the path of this config file.

    Import

    Nginxs can be imported using the resource id, e.g.

     $ pulumi import azure:nginx/configuration:Configuration example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Nginx.NginxPlus/nginxDeployments/dep1/configurations/default

    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 Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
    pulumi/pulumi-azure