Ip Firewall Rules - Replace All

Replaces firewall rules

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/replaceAllIpFirewallRules?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.

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
ipFirewallRules

<string,  IpFirewallRuleProperties>

IP firewall rule properties

Responses

Name Type Description
200 OK

ReplaceAllFirewallRulesOperationResponse

OK

202 Accepted

Accepted

Other Status Codes

ErrorResponse

Examples

Replace all IP firewall rules in a workspace

Sample request

POST https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/replaceAllIpFirewallRules?api-version=2021-06-01

{
  "ipFirewallRules": {
    "ExampleFirewallRule": {
      "startIpAddress": "10.0.0.0",
      "endIpAddress": "10.0.0.254"
    },
    "AnotherExampleFirewallRule": {
      "startIpAddress": "10.0.1.0",
      "endIpAddress": "10.0.1.254"
    }
  }
}

Sample response

{
  "operationId": "00000000-1111-4444-2222-333333333333"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Synapse/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2021-06-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Synapse/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2021-06-01
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

IpFirewallRuleProperties

IP firewall rule properties

ProvisioningState

Resource provisioning state

ReplaceAllFirewallRulesOperationResponse

An existing operation for replacing the firewall rules

ReplaceAllIpFirewallRulesRequest

Replace all IP firewall rules request

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

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

IpFirewallRuleProperties

IP firewall rule properties

Name Type Description
endIpAddress

string

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

provisioningState

ProvisioningState

Resource provisioning state

startIpAddress

string

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

ProvisioningState

Resource provisioning state

Name Type Description
DeleteError

string

Deleting

string

Failed

string

Provisioning

string

Succeeded

string

ReplaceAllFirewallRulesOperationResponse

An existing operation for replacing the firewall rules

Name Type Description
operationId

string

The operation ID

ReplaceAllIpFirewallRulesRequest

Replace all IP firewall rules request

Name Type Description
ipFirewallRules

<string,  IpFirewallRuleProperties>

IP firewall rule properties