1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. UserRuleCollection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.network.UserRuleCollection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

    Defines the user rule collection. Azure REST API version: 2022-04-01-preview. Prior API version in Azure Native 1.x: 2021-02-01-preview.

    Other available API versions: 2021-02-01-preview, 2021-05-01-preview.

    Example Usage

    Create or Update a User Rule Collection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var userRuleCollection = new AzureNative.Network.UserRuleCollection("userRuleCollection", new()
        {
            AppliesToGroups = new[]
            {
                new AzureNative.Network.Inputs.NetworkManagerSecurityGroupItemArgs
                {
                    NetworkGroupId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
                },
            },
            ConfigurationName = "myTestSecurityConfig",
            Description = "A sample policy",
            NetworkManagerName = "testNetworkManager",
            ResourceGroupName = "rg1",
            RuleCollectionName = "testRuleCollection",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewUserRuleCollection(ctx, "userRuleCollection", &network.UserRuleCollectionArgs{
    			AppliesToGroups: network.NetworkManagerSecurityGroupItemArray{
    				&network.NetworkManagerSecurityGroupItemArgs{
    					NetworkGroupId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup"),
    				},
    			},
    			ConfigurationName:  pulumi.String("myTestSecurityConfig"),
    			Description:        pulumi.String("A sample policy"),
    			NetworkManagerName: pulumi.String("testNetworkManager"),
    			ResourceGroupName:  pulumi.String("rg1"),
    			RuleCollectionName: pulumi.String("testRuleCollection"),
    		})
    		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.azurenative.network.UserRuleCollection;
    import com.pulumi.azurenative.network.UserRuleCollectionArgs;
    import com.pulumi.azurenative.network.inputs.NetworkManagerSecurityGroupItemArgs;
    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 userRuleCollection = new UserRuleCollection("userRuleCollection", UserRuleCollectionArgs.builder()
                .appliesToGroups(NetworkManagerSecurityGroupItemArgs.builder()
                    .networkGroupId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup")
                    .build())
                .configurationName("myTestSecurityConfig")
                .description("A sample policy")
                .networkManagerName("testNetworkManager")
                .resourceGroupName("rg1")
                .ruleCollectionName("testRuleCollection")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    user_rule_collection = azure_native.network.UserRuleCollection("userRuleCollection",
        applies_to_groups=[azure_native.network.NetworkManagerSecurityGroupItemArgs(
            network_group_id="/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
        )],
        configuration_name="myTestSecurityConfig",
        description="A sample policy",
        network_manager_name="testNetworkManager",
        resource_group_name="rg1",
        rule_collection_name="testRuleCollection")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const userRuleCollection = new azure_native.network.UserRuleCollection("userRuleCollection", {
        appliesToGroups: [{
            networkGroupId: "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
        }],
        configurationName: "myTestSecurityConfig",
        description: "A sample policy",
        networkManagerName: "testNetworkManager",
        resourceGroupName: "rg1",
        ruleCollectionName: "testRuleCollection",
    });
    
    resources:
      userRuleCollection:
        type: azure-native:network:UserRuleCollection
        properties:
          appliesToGroups:
            - networkGroupId: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup
          configurationName: myTestSecurityConfig
          description: A sample policy
          networkManagerName: testNetworkManager
          resourceGroupName: rg1
          ruleCollectionName: testRuleCollection
    

    Create UserRuleCollection Resource

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

    Constructor syntax

    new UserRuleCollection(name: string, args: UserRuleCollectionArgs, opts?: CustomResourceOptions);
    @overload
    def UserRuleCollection(resource_name: str,
                           args: UserRuleCollectionArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserRuleCollection(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           applies_to_groups: Optional[Sequence[NetworkManagerSecurityGroupItemArgs]] = None,
                           configuration_name: Optional[str] = None,
                           network_manager_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           description: Optional[str] = None,
                           rule_collection_name: Optional[str] = None)
    func NewUserRuleCollection(ctx *Context, name string, args UserRuleCollectionArgs, opts ...ResourceOption) (*UserRuleCollection, error)
    public UserRuleCollection(string name, UserRuleCollectionArgs args, CustomResourceOptions? opts = null)
    public UserRuleCollection(String name, UserRuleCollectionArgs args)
    public UserRuleCollection(String name, UserRuleCollectionArgs args, CustomResourceOptions options)
    
    type: azure-native:network:UserRuleCollection
    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 UserRuleCollectionArgs
    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 UserRuleCollectionArgs
    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 UserRuleCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserRuleCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserRuleCollectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var userRuleCollectionResource = new AzureNative.Network.UserRuleCollection("userRuleCollectionResource", new()
    {
        AppliesToGroups = new[]
        {
            new AzureNative.Network.Inputs.NetworkManagerSecurityGroupItemArgs
            {
                NetworkGroupId = "string",
            },
        },
        ConfigurationName = "string",
        NetworkManagerName = "string",
        ResourceGroupName = "string",
        Description = "string",
        RuleCollectionName = "string",
    });
    
    example, err := network.NewUserRuleCollection(ctx, "userRuleCollectionResource", &network.UserRuleCollectionArgs{
    AppliesToGroups: network.NetworkManagerSecurityGroupItemArray{
    &network.NetworkManagerSecurityGroupItemArgs{
    NetworkGroupId: pulumi.String("string"),
    },
    },
    ConfigurationName: pulumi.String("string"),
    NetworkManagerName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    Description: pulumi.String("string"),
    RuleCollectionName: pulumi.String("string"),
    })
    
    var userRuleCollectionResource = new UserRuleCollection("userRuleCollectionResource", UserRuleCollectionArgs.builder()
        .appliesToGroups(NetworkManagerSecurityGroupItemArgs.builder()
            .networkGroupId("string")
            .build())
        .configurationName("string")
        .networkManagerName("string")
        .resourceGroupName("string")
        .description("string")
        .ruleCollectionName("string")
        .build());
    
    user_rule_collection_resource = azure_native.network.UserRuleCollection("userRuleCollectionResource",
        applies_to_groups=[azure_native.network.NetworkManagerSecurityGroupItemArgs(
            network_group_id="string",
        )],
        configuration_name="string",
        network_manager_name="string",
        resource_group_name="string",
        description="string",
        rule_collection_name="string")
    
    const userRuleCollectionResource = new azure_native.network.UserRuleCollection("userRuleCollectionResource", {
        appliesToGroups: [{
            networkGroupId: "string",
        }],
        configurationName: "string",
        networkManagerName: "string",
        resourceGroupName: "string",
        description: "string",
        ruleCollectionName: "string",
    });
    
    type: azure-native:network:UserRuleCollection
    properties:
        appliesToGroups:
            - networkGroupId: string
        configurationName: string
        description: string
        networkManagerName: string
        resourceGroupName: string
        ruleCollectionName: string
    

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

    AppliesToGroups List<Pulumi.AzureNative.Network.Inputs.NetworkManagerSecurityGroupItem>
    Groups for configuration
    ConfigurationName string
    The name of the network manager Security Configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    Description string
    A description of the user rule collection.
    RuleCollectionName string
    The name of the network manager security Configuration rule collection.
    AppliesToGroups []NetworkManagerSecurityGroupItemArgs
    Groups for configuration
    ConfigurationName string
    The name of the network manager Security Configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    Description string
    A description of the user rule collection.
    RuleCollectionName string
    The name of the network manager security Configuration rule collection.
    appliesToGroups List<NetworkManagerSecurityGroupItem>
    Groups for configuration
    configurationName String
    The name of the network manager Security Configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the user rule collection.
    ruleCollectionName String
    The name of the network manager security Configuration rule collection.
    appliesToGroups NetworkManagerSecurityGroupItem[]
    Groups for configuration
    configurationName string
    The name of the network manager Security Configuration.
    networkManagerName string
    The name of the network manager.
    resourceGroupName string
    The name of the resource group.
    description string
    A description of the user rule collection.
    ruleCollectionName string
    The name of the network manager security Configuration rule collection.
    applies_to_groups Sequence[NetworkManagerSecurityGroupItemArgs]
    Groups for configuration
    configuration_name str
    The name of the network manager Security Configuration.
    network_manager_name str
    The name of the network manager.
    resource_group_name str
    The name of the resource group.
    description str
    A description of the user rule collection.
    rule_collection_name str
    The name of the network manager security Configuration rule collection.
    appliesToGroups List<Property Map>
    Groups for configuration
    configurationName String
    The name of the network manager Security Configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    description String
    A description of the user rule collection.
    ruleCollectionName String
    The name of the network manager security Configuration rule collection.

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the resource.
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the resource.
    SystemData SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type String
    Resource type.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type string
    Resource type.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the resource.
    system_data SystemDataResponse
    The system metadata related to this resource.
    type str
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.

    Supporting Types

    NetworkManagerSecurityGroupItem, NetworkManagerSecurityGroupItemArgs

    NetworkGroupId string
    Network manager group Id.
    NetworkGroupId string
    Network manager group Id.
    networkGroupId String
    Network manager group Id.
    networkGroupId string
    Network manager group Id.
    network_group_id str
    Network manager group Id.
    networkGroupId String
    Network manager group Id.

    NetworkManagerSecurityGroupItemResponse, NetworkManagerSecurityGroupItemResponseArgs

    NetworkGroupId string
    Network manager group Id.
    NetworkGroupId string
    Network manager group Id.
    networkGroupId String
    Network manager group Id.
    networkGroupId string
    Network manager group Id.
    network_group_id str
    Network manager group Id.
    networkGroupId String
    Network manager group Id.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:UserRuleCollection myTestSecurityConfig /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi