1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getUserRule
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.network.getUserRule

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Gets a user rule. Azure REST API version: 2022-04-01-preview.

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

    Using getUserRule

    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 getUserRule(args: GetUserRuleArgs, opts?: InvokeOptions): Promise<GetUserRuleResult>
    function getUserRuleOutput(args: GetUserRuleOutputArgs, opts?: InvokeOptions): Output<GetUserRuleResult>
    def get_user_rule(configuration_name: Optional[str] = None,
                      network_manager_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      rule_collection_name: Optional[str] = None,
                      rule_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetUserRuleResult
    def get_user_rule_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,
                      rule_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetUserRuleResult]
    func LookupUserRule(ctx *Context, args *LookupUserRuleArgs, opts ...InvokeOption) (*LookupUserRuleResult, error)
    func LookupUserRuleOutput(ctx *Context, args *LookupUserRuleOutputArgs, opts ...InvokeOption) LookupUserRuleResultOutput

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

    public static class GetUserRule 
    {
        public static Task<GetUserRuleResult> InvokeAsync(GetUserRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetUserRuleResult> Invoke(GetUserRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserRuleResult> getUserRule(GetUserRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getUserRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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.
    RuleCollectionName string
    The name of the network manager security Configuration rule collection.
    RuleName string
    The name of the rule.
    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.
    RuleCollectionName string
    The name of the network manager security Configuration rule collection.
    RuleName string
    The name of the rule.
    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.
    ruleCollectionName String
    The name of the network manager security Configuration rule collection.
    ruleName String
    The name of the rule.
    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.
    ruleCollectionName string
    The name of the network manager security Configuration rule collection.
    ruleName string
    The name of the rule.
    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.
    rule_collection_name str
    The name of the network manager security Configuration rule collection.
    rule_name str
    The name of the rule.
    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.
    ruleCollectionName String
    The name of the network manager security Configuration rule collection.
    ruleName String
    The name of the rule.

    getUserRule Result

    The following output properties are available:

    Direction string
    Indicates if the traffic matched against the rule in inbound or outbound.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Resource ID.
    Name string
    Resource name.
    Protocol string
    Network protocol this rule applies to.
    ProvisioningState string
    The provisioning state of the security configuration user rule resource.
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    Description string
    A description for this rule.
    DestinationPortRanges List<string>
    The destination port ranges.
    Destinations List<Pulumi.AzureNative.Network.Outputs.AddressPrefixItemResponse>
    The destination address prefixes. CIDR or destination IP ranges.
    SourcePortRanges List<string>
    The source port ranges.
    Sources List<Pulumi.AzureNative.Network.Outputs.AddressPrefixItemResponse>
    The CIDR or source IP ranges.
    Direction string
    Indicates if the traffic matched against the rule in inbound or outbound.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Resource ID.
    Name string
    Resource name.
    Protocol string
    Network protocol this rule applies to.
    ProvisioningState string
    The provisioning state of the security configuration user rule resource.
    SystemData SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    Description string
    A description for this rule.
    DestinationPortRanges []string
    The destination port ranges.
    Destinations []AddressPrefixItemResponse
    The destination address prefixes. CIDR or destination IP ranges.
    SourcePortRanges []string
    The source port ranges.
    Sources []AddressPrefixItemResponse
    The CIDR or source IP ranges.
    direction String
    Indicates if the traffic matched against the rule in inbound or outbound.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Resource ID.
    name String
    Resource name.
    protocol String
    Network protocol this rule applies to.
    provisioningState String
    The provisioning state of the security configuration user rule resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type String
    Resource type.
    description String
    A description for this rule.
    destinationPortRanges List<String>
    The destination port ranges.
    destinations List<AddressPrefixItemResponse>
    The destination address prefixes. CIDR or destination IP ranges.
    sourcePortRanges List<String>
    The source port ranges.
    sources List<AddressPrefixItemResponse>
    The CIDR or source IP ranges.
    direction string
    Indicates if the traffic matched against the rule in inbound or outbound.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    Resource ID.
    name string
    Resource name.
    protocol string
    Network protocol this rule applies to.
    provisioningState string
    The provisioning state of the security configuration user rule resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type string
    Resource type.
    description string
    A description for this rule.
    destinationPortRanges string[]
    The destination port ranges.
    destinations AddressPrefixItemResponse[]
    The destination address prefixes. CIDR or destination IP ranges.
    sourcePortRanges string[]
    The source port ranges.
    sources AddressPrefixItemResponse[]
    The CIDR or source IP ranges.
    direction str
    Indicates if the traffic matched against the rule in inbound or outbound.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    Resource ID.
    name str
    Resource name.
    protocol str
    Network protocol this rule applies to.
    provisioning_state str
    The provisioning state of the security configuration user rule resource.
    system_data SystemDataResponse
    The system metadata related to this resource.
    type str
    Resource type.
    description str
    A description for this rule.
    destination_port_ranges Sequence[str]
    The destination port ranges.
    destinations Sequence[AddressPrefixItemResponse]
    The destination address prefixes. CIDR or destination IP ranges.
    source_port_ranges Sequence[str]
    The source port ranges.
    sources Sequence[AddressPrefixItemResponse]
    The CIDR or source IP ranges.
    direction String
    Indicates if the traffic matched against the rule in inbound or outbound.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Resource ID.
    name String
    Resource name.
    protocol String
    Network protocol this rule applies to.
    provisioningState String
    The provisioning state of the security configuration user rule resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.
    description String
    A description for this rule.
    destinationPortRanges List<String>
    The destination port ranges.
    destinations List<Property Map>
    The destination address prefixes. CIDR or destination IP ranges.
    sourcePortRanges List<String>
    The source port ranges.
    sources List<Property Map>
    The CIDR or source IP ranges.

    Supporting Types

    AddressPrefixItemResponse

    AddressPrefix string
    Address prefix.
    AddressPrefixType string
    Address prefix type.
    AddressPrefix string
    Address prefix.
    AddressPrefixType string
    Address prefix type.
    addressPrefix String
    Address prefix.
    addressPrefixType String
    Address prefix type.
    addressPrefix string
    Address prefix.
    addressPrefixType string
    Address prefix type.
    address_prefix str
    Address prefix.
    address_prefix_type str
    Address prefix type.
    addressPrefix String
    Address prefix.
    addressPrefixType String
    Address prefix type.

    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
    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.46.0 published on Friday, Jun 21, 2024 by Pulumi