1. Packages
  2. Azure Classic
  3. API Docs
  4. iotcentral
  5. ApplicationNetworkRuleSet

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.iotcentral.ApplicationNetworkRuleSet

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages an IoT Central Application Network Rule Set.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resource",
        location: "West Europe",
    });
    const exampleApplication = new azure.iotcentral.Application("example", {
        name: "example-iotcentral-app",
        resourceGroupName: example.name,
        location: example.location,
        subDomain: "example-iotcentral-app-subdomain",
        displayName: "example-iotcentral-app-display-name",
        sku: "ST1",
        tags: {
            Foo: "Bar",
        },
    });
    const exampleApplicationNetworkRuleSet = new azure.iotcentral.ApplicationNetworkRuleSet("example", {
        iotcentralApplicationId: exampleApplication.id,
        ipRules: [
            {
                name: "rule1",
                ipMask: "10.0.1.0/24",
            },
            {
                name: "rule2",
                ipMask: "10.1.1.0/24",
            },
        ],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resource",
        location="West Europe")
    example_application = azure.iotcentral.Application("example",
        name="example-iotcentral-app",
        resource_group_name=example.name,
        location=example.location,
        sub_domain="example-iotcentral-app-subdomain",
        display_name="example-iotcentral-app-display-name",
        sku="ST1",
        tags={
            "Foo": "Bar",
        })
    example_application_network_rule_set = azure.iotcentral.ApplicationNetworkRuleSet("example",
        iotcentral_application_id=example_application.id,
        ip_rules=[
            {
                "name": "rule1",
                "ipMask": "10.0.1.0/24",
            },
            {
                "name": "rule2",
                "ipMask": "10.1.1.0/24",
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iotcentral"
    	"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-resource"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleApplication, err := iotcentral.NewApplication(ctx, "example", &iotcentral.ApplicationArgs{
    			Name:              pulumi.String("example-iotcentral-app"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			SubDomain:         pulumi.String("example-iotcentral-app-subdomain"),
    			DisplayName:       pulumi.String("example-iotcentral-app-display-name"),
    			Sku:               pulumi.String("ST1"),
    			Tags: pulumi.StringMap{
    				"Foo": pulumi.String("Bar"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = iotcentral.NewApplicationNetworkRuleSet(ctx, "example", &iotcentral.ApplicationNetworkRuleSetArgs{
    			IotcentralApplicationId: exampleApplication.ID(),
    			IpRules: iotcentral.ApplicationNetworkRuleSetIpRuleArray{
    				&iotcentral.ApplicationNetworkRuleSetIpRuleArgs{
    					Name:   pulumi.String("rule1"),
    					IpMask: pulumi.String("10.0.1.0/24"),
    				},
    				&iotcentral.ApplicationNetworkRuleSetIpRuleArgs{
    					Name:   pulumi.String("rule2"),
    					IpMask: pulumi.String("10.1.1.0/24"),
    				},
    			},
    		})
    		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-resource",
            Location = "West Europe",
        });
    
        var exampleApplication = new Azure.IotCentral.Application("example", new()
        {
            Name = "example-iotcentral-app",
            ResourceGroupName = example.Name,
            Location = example.Location,
            SubDomain = "example-iotcentral-app-subdomain",
            DisplayName = "example-iotcentral-app-display-name",
            Sku = "ST1",
            Tags = 
            {
                { "Foo", "Bar" },
            },
        });
    
        var exampleApplicationNetworkRuleSet = new Azure.IotCentral.ApplicationNetworkRuleSet("example", new()
        {
            IotcentralApplicationId = exampleApplication.Id,
            IpRules = new[]
            {
                new Azure.IotCentral.Inputs.ApplicationNetworkRuleSetIpRuleArgs
                {
                    Name = "rule1",
                    IpMask = "10.0.1.0/24",
                },
                new Azure.IotCentral.Inputs.ApplicationNetworkRuleSetIpRuleArgs
                {
                    Name = "rule2",
                    IpMask = "10.1.1.0/24",
                },
            },
        });
    
    });
    
    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.iotcentral.Application;
    import com.pulumi.azure.iotcentral.ApplicationArgs;
    import com.pulumi.azure.iotcentral.ApplicationNetworkRuleSet;
    import com.pulumi.azure.iotcentral.ApplicationNetworkRuleSetArgs;
    import com.pulumi.azure.iotcentral.inputs.ApplicationNetworkRuleSetIpRuleArgs;
    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-resource")
                .location("West Europe")
                .build());
    
            var exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
                .name("example-iotcentral-app")
                .resourceGroupName(example.name())
                .location(example.location())
                .subDomain("example-iotcentral-app-subdomain")
                .displayName("example-iotcentral-app-display-name")
                .sku("ST1")
                .tags(Map.of("Foo", "Bar"))
                .build());
    
            var exampleApplicationNetworkRuleSet = new ApplicationNetworkRuleSet("exampleApplicationNetworkRuleSet", ApplicationNetworkRuleSetArgs.builder()
                .iotcentralApplicationId(exampleApplication.id())
                .ipRules(            
                    ApplicationNetworkRuleSetIpRuleArgs.builder()
                        .name("rule1")
                        .ipMask("10.0.1.0/24")
                        .build(),
                    ApplicationNetworkRuleSetIpRuleArgs.builder()
                        .name("rule2")
                        .ipMask("10.1.1.0/24")
                        .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resource
          location: West Europe
      exampleApplication:
        type: azure:iotcentral:Application
        name: example
        properties:
          name: example-iotcentral-app
          resourceGroupName: ${example.name}
          location: ${example.location}
          subDomain: example-iotcentral-app-subdomain
          displayName: example-iotcentral-app-display-name
          sku: ST1
          tags:
            Foo: Bar
      exampleApplicationNetworkRuleSet:
        type: azure:iotcentral:ApplicationNetworkRuleSet
        name: example
        properties:
          iotcentralApplicationId: ${exampleApplication.id}
          ipRules:
            - name: rule1
              ipMask: 10.0.1.0/24
            - name: rule2
              ipMask: 10.1.1.0/24
    

    Create ApplicationNetworkRuleSet Resource

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

    Constructor syntax

    new ApplicationNetworkRuleSet(name: string, args: ApplicationNetworkRuleSetArgs, opts?: CustomResourceOptions);
    @overload
    def ApplicationNetworkRuleSet(resource_name: str,
                                  args: ApplicationNetworkRuleSetArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplicationNetworkRuleSet(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  iotcentral_application_id: Optional[str] = None,
                                  apply_to_device: Optional[bool] = None,
                                  default_action: Optional[str] = None,
                                  ip_rules: Optional[Sequence[ApplicationNetworkRuleSetIpRuleArgs]] = None)
    func NewApplicationNetworkRuleSet(ctx *Context, name string, args ApplicationNetworkRuleSetArgs, opts ...ResourceOption) (*ApplicationNetworkRuleSet, error)
    public ApplicationNetworkRuleSet(string name, ApplicationNetworkRuleSetArgs args, CustomResourceOptions? opts = null)
    public ApplicationNetworkRuleSet(String name, ApplicationNetworkRuleSetArgs args)
    public ApplicationNetworkRuleSet(String name, ApplicationNetworkRuleSetArgs args, CustomResourceOptions options)
    
    type: azure:iotcentral:ApplicationNetworkRuleSet
    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 ApplicationNetworkRuleSetArgs
    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 ApplicationNetworkRuleSetArgs
    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 ApplicationNetworkRuleSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationNetworkRuleSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationNetworkRuleSetArgs
    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 applicationNetworkRuleSetResource = new Azure.IotCentral.ApplicationNetworkRuleSet("applicationNetworkRuleSetResource", new()
    {
        IotcentralApplicationId = "string",
        ApplyToDevice = false,
        DefaultAction = "string",
        IpRules = new[]
        {
            new Azure.IotCentral.Inputs.ApplicationNetworkRuleSetIpRuleArgs
            {
                IpMask = "string",
                Name = "string",
            },
        },
    });
    
    example, err := iotcentral.NewApplicationNetworkRuleSet(ctx, "applicationNetworkRuleSetResource", &iotcentral.ApplicationNetworkRuleSetArgs{
    	IotcentralApplicationId: pulumi.String("string"),
    	ApplyToDevice:           pulumi.Bool(false),
    	DefaultAction:           pulumi.String("string"),
    	IpRules: iotcentral.ApplicationNetworkRuleSetIpRuleArray{
    		&iotcentral.ApplicationNetworkRuleSetIpRuleArgs{
    			IpMask: pulumi.String("string"),
    			Name:   pulumi.String("string"),
    		},
    	},
    })
    
    var applicationNetworkRuleSetResource = new ApplicationNetworkRuleSet("applicationNetworkRuleSetResource", ApplicationNetworkRuleSetArgs.builder()
        .iotcentralApplicationId("string")
        .applyToDevice(false)
        .defaultAction("string")
        .ipRules(ApplicationNetworkRuleSetIpRuleArgs.builder()
            .ipMask("string")
            .name("string")
            .build())
        .build());
    
    application_network_rule_set_resource = azure.iotcentral.ApplicationNetworkRuleSet("applicationNetworkRuleSetResource",
        iotcentral_application_id="string",
        apply_to_device=False,
        default_action="string",
        ip_rules=[{
            "ipMask": "string",
            "name": "string",
        }])
    
    const applicationNetworkRuleSetResource = new azure.iotcentral.ApplicationNetworkRuleSet("applicationNetworkRuleSetResource", {
        iotcentralApplicationId: "string",
        applyToDevice: false,
        defaultAction: "string",
        ipRules: [{
            ipMask: "string",
            name: "string",
        }],
    });
    
    type: azure:iotcentral:ApplicationNetworkRuleSet
    properties:
        applyToDevice: false
        defaultAction: string
        iotcentralApplicationId: string
        ipRules:
            - ipMask: string
              name: string
    

    ApplicationNetworkRuleSet 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 ApplicationNetworkRuleSet resource accepts the following input properties:

    IotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ApplyToDevice bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    DefaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    IpRules List<Pulumi.Azure.IotCentral.Inputs.ApplicationNetworkRuleSetIpRule>
    One or more ip_rule blocks as defined below.
    IotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ApplyToDevice bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    DefaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    IpRules []ApplicationNetworkRuleSetIpRuleArgs
    One or more ip_rule blocks as defined below.
    iotcentralApplicationId String
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    applyToDevice Boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction String
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    ipRules List<ApplicationNetworkRuleSetIpRule>
    One or more ip_rule blocks as defined below.
    iotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    applyToDevice boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    ipRules ApplicationNetworkRuleSetIpRule[]
    One or more ip_rule blocks as defined below.
    iotcentral_application_id str
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    apply_to_device bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    default_action str
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    ip_rules Sequence[ApplicationNetworkRuleSetIpRuleArgs]
    One or more ip_rule blocks as defined below.
    iotcentralApplicationId String
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    applyToDevice Boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction String
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    ipRules List<Property Map>
    One or more ip_rule blocks as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationNetworkRuleSet 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 ApplicationNetworkRuleSet Resource

    Get an existing ApplicationNetworkRuleSet 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?: ApplicationNetworkRuleSetState, opts?: CustomResourceOptions): ApplicationNetworkRuleSet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apply_to_device: Optional[bool] = None,
            default_action: Optional[str] = None,
            iotcentral_application_id: Optional[str] = None,
            ip_rules: Optional[Sequence[ApplicationNetworkRuleSetIpRuleArgs]] = None) -> ApplicationNetworkRuleSet
    func GetApplicationNetworkRuleSet(ctx *Context, name string, id IDInput, state *ApplicationNetworkRuleSetState, opts ...ResourceOption) (*ApplicationNetworkRuleSet, error)
    public static ApplicationNetworkRuleSet Get(string name, Input<string> id, ApplicationNetworkRuleSetState? state, CustomResourceOptions? opts = null)
    public static ApplicationNetworkRuleSet get(String name, Output<String> id, ApplicationNetworkRuleSetState 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:
    ApplyToDevice bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    DefaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    IotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    IpRules List<Pulumi.Azure.IotCentral.Inputs.ApplicationNetworkRuleSetIpRule>
    One or more ip_rule blocks as defined below.
    ApplyToDevice bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    DefaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    IotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    IpRules []ApplicationNetworkRuleSetIpRuleArgs
    One or more ip_rule blocks as defined below.
    applyToDevice Boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction String
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    iotcentralApplicationId String
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ipRules List<ApplicationNetworkRuleSetIpRule>
    One or more ip_rule blocks as defined below.
    applyToDevice boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction string
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    iotcentralApplicationId string
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ipRules ApplicationNetworkRuleSetIpRule[]
    One or more ip_rule blocks as defined below.
    apply_to_device bool
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    default_action str
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    iotcentral_application_id str
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ip_rules Sequence[ApplicationNetworkRuleSetIpRuleArgs]
    One or more ip_rule blocks as defined below.
    applyToDevice Boolean
    Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are true, false. Defaults to true
    defaultAction String
    Specifies the default action for the IoT Central Application Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
    iotcentralApplicationId String
    The ID of the IoT Central Application. Changing this forces a new resource to be created.
    ipRules List<Property Map>
    One or more ip_rule blocks as defined below.

    Supporting Types

    ApplicationNetworkRuleSetIpRule, ApplicationNetworkRuleSetIpRuleArgs

    IpMask string
    The IP address range in CIDR notation for the IP Rule.
    Name string
    The name of the IP Rule
    IpMask string
    The IP address range in CIDR notation for the IP Rule.
    Name string
    The name of the IP Rule
    ipMask String
    The IP address range in CIDR notation for the IP Rule.
    name String
    The name of the IP Rule
    ipMask string
    The IP address range in CIDR notation for the IP Rule.
    name string
    The name of the IP Rule
    ip_mask str
    The IP address range in CIDR notation for the IP Rule.
    name str
    The name of the IP Rule
    ipMask String
    The IP address range in CIDR notation for the IP Rule.
    name String
    The name of the IP Rule

    Import

    IoT Central Application Network Rule Sets can be imported using the resource id, e.g.

    $ pulumi import azure:iotcentral/applicationNetworkRuleSet:ApplicationNetworkRuleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.IoTCentral/iotApps/app1
    

    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 Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi