Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. getIpFirewallRule
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.synapse.getIpFirewallRule

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a firewall rule Azure REST API version: 2021-06-01.

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

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>
Copy
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]
Copy
func LookupIpFirewallRule(ctx *Context, args *LookupIpFirewallRuleArgs, opts ...InvokeOption) (*LookupIpFirewallRuleResult, error)
func LookupIpFirewallRuleOutput(ctx *Context, args *LookupIpFirewallRuleOutputArgs, opts ...InvokeOption) LookupIpFirewallRuleResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetIpFirewallRuleResult> getIpFirewallRule(GetIpFirewallRuleArgs args, InvokeOptions options)
public static Output<GetIpFirewallRuleResult> getIpFirewallRule(GetIpFirewallRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getIpFirewallRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleName
This property is required.
Changes to this property will trigger replacement.
string
The IP firewall rule name
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleName
This property is required.
Changes to this property will trigger replacement.
string
The IP firewall rule name
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleName
This property is required.
Changes to this property will trigger replacement.
String
The IP firewall rule name
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ruleName
This property is required.
Changes to this property will trigger replacement.
string
The IP firewall rule name
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
rule_name
This property is required.
Changes to this property will trigger replacement.
str
The IP firewall rule name
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleName
This property is required.
Changes to this property will trigger replacement.
String
The IP firewall rule name
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getIpFirewallRule Result

The following output properties are available:

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
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
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
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
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
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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native