Share via

Microsoft.Synapse workspaces/firewallRules 2020-12-01

Bicep resource definition

The workspaces/firewallRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/firewallRules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/firewallRules@2020-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

Property Values

Microsoft.Synapse/workspaces/firewallRules

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces
properties IP firewall rule properties IpFirewallRuleProperties

IpFirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress string
startIpAddress The start IP address of the firewall rule. Must be IPv4 format string

ARM template resource definition

The workspaces/firewallRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/firewallRules resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/firewallRules",
  "apiVersion": "2020-12-01",
  "name": "string",
  "properties": {
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

Property Values

Microsoft.Synapse/workspaces/firewallRules

Name Description Value
apiVersion The api version '2020-12-01'
name The resource name string (required)
properties IP firewall rule properties IpFirewallRuleProperties
type The resource type 'Microsoft.Synapse/workspaces/firewallRules'

IpFirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress string
startIpAddress The start IP address of the firewall rule. Must be IPv4 format string

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaces/firewallRules resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/firewallRules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/firewallRules@2020-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      endIpAddress = "string"
      startIpAddress = "string"
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/firewallRules

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties IP firewall rule properties IpFirewallRuleProperties
type The resource type "Microsoft.Synapse/workspaces/firewallRules@2020-12-01"

IpFirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress string
startIpAddress The start IP address of the firewall rule. Must be IPv4 format string