1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getUserRuleCollection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.network.getUserRuleCollection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets a network manager security user configuration rule collection.

Uses Azure REST API version 2022-04-01-preview.

Other available API versions: 2021-02-01-preview, 2022-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getUserRuleCollection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserRuleCollection(args: GetUserRuleCollectionArgs, opts?: InvokeOptions): Promise<GetUserRuleCollectionResult>
function getUserRuleCollectionOutput(args: GetUserRuleCollectionOutputArgs, opts?: InvokeOptions): Output<GetUserRuleCollectionResult>
Copy
def get_user_rule_collection(configuration_name: Optional[str] = None,
                             network_manager_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             rule_collection_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetUserRuleCollectionResult
def get_user_rule_collection_output(configuration_name: Optional[pulumi.Input[str]] = None,
                             network_manager_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             rule_collection_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetUserRuleCollectionResult]
Copy
func LookupUserRuleCollection(ctx *Context, args *LookupUserRuleCollectionArgs, opts ...InvokeOption) (*LookupUserRuleCollectionResult, error)
func LookupUserRuleCollectionOutput(ctx *Context, args *LookupUserRuleCollectionOutputArgs, opts ...InvokeOption) LookupUserRuleCollectionResultOutput
Copy

> Note: This function is named LookupUserRuleCollection in the Go SDK.

public static class GetUserRuleCollection 
{
    public static Task<GetUserRuleCollectionResult> InvokeAsync(GetUserRuleCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetUserRuleCollectionResult> Invoke(GetUserRuleCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserRuleCollectionResult> getUserRuleCollection(GetUserRuleCollectionArgs args, InvokeOptions options)
public static Output<GetUserRuleCollectionResult> getUserRuleCollection(GetUserRuleCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getUserRuleCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Security Configuration.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager security Configuration rule collection.
ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Security Configuration.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager security Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager Security Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager security Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Security Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager security Configuration rule collection.
configuration_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager Security Configuration.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
rule_collection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager security Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager Security Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager security Configuration rule collection.

getUserRuleCollection Result

The following output properties are available:

AppliesToGroups List<Pulumi.AzureNative.Network.Outputs.NetworkManagerSecurityGroupItemResponse>
Groups for configuration
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
Description string
A description of the user rule collection.
AppliesToGroups []NetworkManagerSecurityGroupItemResponse
Groups for configuration
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
Description string
A description of the user rule collection.
appliesToGroups List<NetworkManagerSecurityGroupItemResponse>
Groups for configuration
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
description String
A description of the user rule collection.
appliesToGroups NetworkManagerSecurityGroupItemResponse[]
Groups for configuration
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Resource ID.
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.
description string
A description of the user rule collection.
applies_to_groups Sequence[NetworkManagerSecurityGroupItemResponse]
Groups for configuration
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Resource ID.
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.
description str
A description of the user rule collection.
appliesToGroups List<Property Map>
Groups for configuration
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
description String
A description of the user rule collection.

Supporting Types

NetworkManagerSecurityGroupItemResponse

NetworkGroupId This property is required. string
Network manager group Id.
NetworkGroupId This property is required. string
Network manager group Id.
networkGroupId This property is required. String
Network manager group Id.
networkGroupId This property is required. string
Network manager group Id.
network_group_id This property is required. str
Network manager group Id.
networkGroupId This property is required. String
Network manager group Id.

SystemDataResponse

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi