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 |
---|---|---|---|---|
resource
|
path | True |
|
The name of the resource group. The name is case insensitive. |
rule
|
path | True |
|
The IP firewall rule name |
subscription
|
path | True |
|
The ID of the target subscription. |
workspace
|
path | True |
|
The name of the workspace. |
api-version
|
query | True |
|
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
properties.endIpAddress |
|
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress |
properties.startIpAddress |
|
The start IP address of the firewall rule. Must be IPv4 format |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
201 Created | ||
202 Accepted | ||
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
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Ip |
IP firewall rule |
Provisioning |
Resource provisioning state |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
|
The additional info. |
type |
|
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
|
The error code. |
details |
The error details. |
|
message |
|
The error message. |
target |
|
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
IpFirewallRuleInfo
IP firewall rule
Name | Type | Description |
---|---|---|
id |
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
|
The name of the resource |
properties.endIpAddress |
|
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 |
|
The start IP address of the firewall rule. Must be IPv4 format |
type |
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ProvisioningState
Resource provisioning state
Name | Type | Description |
---|---|---|
DeleteError |
|
|
Deleting |
|
|
Failed |
|
|
Provisioning |
|
|
Succeeded |
|