1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getIpFirewallRule
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.synapse.getIpFirewallRule

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Get a firewall rule

    Uses Azure REST API version 2021-06-01.

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

    Using getIpFirewallRule

    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 getIpFirewallRule(args: GetIpFirewallRuleArgs, opts?: InvokeOptions): Promise<GetIpFirewallRuleResult>
    function getIpFirewallRuleOutput(args: GetIpFirewallRuleOutputArgs, opts?: InvokeOptions): Output<GetIpFirewallRuleResult>
    def get_ip_firewall_rule(resource_group_name: Optional[str] = None,
                             rule_name: Optional[str] = None,
                             workspace_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIpFirewallRuleResult
    def get_ip_firewall_rule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                             rule_name: Optional[pulumi.Input[str]] = None,
                             workspace_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIpFirewallRuleResult]
    func LookupIpFirewallRule(ctx *Context, args *LookupIpFirewallRuleArgs, opts ...InvokeOption) (*LookupIpFirewallRuleResult, error)
    func LookupIpFirewallRuleOutput(ctx *Context, args *LookupIpFirewallRuleOutputArgs, opts ...InvokeOption) LookupIpFirewallRuleResultOutput

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

    public static class GetIpFirewallRule 
    {
        public static Task<GetIpFirewallRuleResult> InvokeAsync(GetIpFirewallRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetIpFirewallRuleResult> Invoke(GetIpFirewallRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpFirewallRuleResult> getIpFirewallRule(GetIpFirewallRuleArgs args, InvokeOptions options)
    public static Output<GetIpFirewallRuleResult> getIpFirewallRule(GetIpFirewallRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:synapse:getIpFirewallRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RuleName string
    The IP firewall rule name
    WorkspaceName string
    The name of the workspace.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RuleName string
    The IP firewall rule name
    WorkspaceName string
    The name of the workspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ruleName String
    The IP firewall rule name
    workspaceName String
    The name of the workspace.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    ruleName string
    The IP firewall rule name
    workspaceName string
    The name of the workspace.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    rule_name str
    The IP firewall rule name
    workspace_name str
    The name of the workspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ruleName String
    The IP firewall rule name
    workspaceName String
    The name of the workspace.

    getIpFirewallRule Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    ProvisioningState string
    Resource provisioning state
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    EndIpAddress string
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    StartIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    ProvisioningState string
    Resource provisioning state
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    EndIpAddress string
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    StartIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    provisioningState String
    Resource provisioning state
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    endIpAddress String
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    startIpAddress String
    The start IP address of the firewall rule. Must be IPv4 format
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    provisioningState string
    Resource provisioning state
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    endIpAddress string
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    startIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    provisioning_state str
    Resource provisioning state
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    end_ip_address str
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    start_ip_address str
    The start IP address of the firewall rule. Must be IPv4 format
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    provisioningState String
    Resource provisioning state
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    endIpAddress String
    The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
    startIpAddress String
    The start IP address of the firewall rule. Must be IPv4 format

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi