Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getFirewallRule
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.getFirewallRule

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets information about a mongo cluster firewall rule. Azure REST API version: 2024-03-01-preview.

    Other available API versions: 2024-06-01-preview, 2024-07-01.

    Using getFirewallRule

    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 getFirewallRule(args: GetFirewallRuleArgs, opts?: InvokeOptions): Promise<GetFirewallRuleResult>
function getFirewallRuleOutput(args: GetFirewallRuleOutputArgs, opts?: InvokeOptions): Output<GetFirewallRuleResult>
    def get_firewall_rule(firewall_rule_name: Optional[str] = None,
                      mongo_cluster_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetFirewallRuleResult
def get_firewall_rule_output(firewall_rule_name: Optional[pulumi.Input[str]] = None,
                      mongo_cluster_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetFirewallRuleResult]
    func LookupFirewallRule(ctx *Context, args *LookupFirewallRuleArgs, opts ...InvokeOption) (*LookupFirewallRuleResult, error)
func LookupFirewallRuleOutput(ctx *Context, args *LookupFirewallRuleOutputArgs, opts ...InvokeOption) LookupFirewallRuleResultOutput

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

    public static class GetFirewallRule 
{
    public static Task<GetFirewallRuleResult> InvokeAsync(GetFirewallRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallRuleResult> Invoke(GetFirewallRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFirewallRuleResult> getFirewallRule(GetFirewallRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:documentdb:getFirewallRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    firewallRuleName String
    The name of the mongo cluster firewall rule.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    firewallRuleName string
    The name of the mongo cluster firewall rule.
    mongoClusterName string
    The name of the mongo cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    firewall_rule_name str
    The name of the mongo cluster firewall rule.
    mongo_cluster_name str
    The name of the mongo cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    firewallRuleName String
    The name of the mongo cluster firewall rule.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getFirewallRule Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.DocumentDB.Outputs.FirewallRulePropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.DocumentDB.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties FirewallRulePropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties FirewallRulePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties FirewallRulePropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties FirewallRulePropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    FirewallRulePropertiesResponse

    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    ProvisioningState string
    The provisioning state of the firewall rule.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    ProvisioningState string
    The provisioning state of the firewall rule.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    provisioningState String
    The provisioning state of the firewall rule.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    provisioningState string
    The provisioning state of the firewall rule.
    startIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    end_ip_address str
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    provisioning_state str
    The provisioning state of the firewall rule.
    start_ip_address str
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    provisioningState String
    The provisioning state of the firewall rule.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.

    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native