Ip Firewall Rules - Create Or Update

Creates or updates a firewall rule

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules/{ruleName}?api-version=2021-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

ruleName
path True
  • string

The IP firewall rule name

subscriptionId
path True
  • string

The ID of the target subscription.

workspaceName
path True
  • string

The name of the workspace

api-version
query True
  • string

The API version to use for this operation.

Request Body

Name Type Description
properties.endIpAddress
  • string

The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress

properties.startIpAddress
  • string

The start IP address of the firewall rule. Must be IPv4 format

Responses

Name Type Description
200 OK
201 Created
Other Status Codes

Examples

Create an IP firewall rule

Sample Request

PUT https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule?api-version=2021-06-01
{
  "properties": {
    "startIpAddress": "10.0.0.0",
    "endIpAddress": "10.0.0.254"
  }
}

Sample Response

{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule",
  "type": "Microsoft.Synapse/workspaces/firewallRules",
  "name": "ExampleIpFirewallRule",
  "properties": {
    "startIpAddress": "10.0.0.0",
    "endIpAddress": "10.0.0.254",
    "provisioningState": "Provisioning"
  }
}
{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule",
  "type": "Microsoft.Synapse/workspaces/firewallRules",
  "name": "ExampleIpFirewallRule",
  "properties": {
    "startIpAddress": "10.0.0.0",
    "endIpAddress": "10.0.0.254",
    "provisioningState": "Provisioning"
  }
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitions

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

IpFirewallRuleInfo

IP firewall rule

ProvisioningState

Resource provisioning state

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

IpFirewallRuleInfo

IP firewall rule

Name Type Description
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

properties.endIpAddress
  • string

The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress

properties.provisioningState

Resource provisioning state

properties.startIpAddress
  • string

The start IP address of the firewall rule. Must be IPv4 format

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ProvisioningState

Resource provisioning state

Name Type Description
DeleteError
  • string
Deleting
  • string
Failed
  • string
Provisioning
  • string
Succeeded
  • string