Ip Firewall Rules - Create Or Update

Service:

Synapse

API Version:

2021-06-01

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	IpFirewallRuleInfo
201 Created	IpFirewallRuleInfo
202 Accepted
Other Status Codes	ErrorResponse

Examples

Create an IP firewall rule

Sample Request

HTTP

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"
  }
}

Java

/** Samples for IpFirewallRules CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateIpFirewallRule.json
     */
    /**
     * Sample code: Create an IP firewall rule.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void createAnIPFirewallRule(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .ipFirewallRules()
            .define("ExampleIpFirewallRule")
            .withExistingWorkspace("ExampleResourceGroup", "ExampleWorkspace")
            .withEndIpAddress("10.0.0.254")
            .withStartIpAddress("10.0.0.0")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python create_ip_firewall_rule.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="01234567-89ab-4def-0123-456789abcdef",
    )

    response = client.ip_firewall_rules.begin_create_or_update(
        resource_group_name="ExampleResourceGroup",
        workspace_name="ExampleWorkspace",
        rule_name="ExampleIpFirewallRule",
        ip_firewall_rule_info={"properties": {"endIpAddress": "10.0.0.254", "startIpAddress": "10.0.0.0"}},
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateIpFirewallRule.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateIpFirewallRule.json
func ExampleIPFirewallRulesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armsynapse.NewIPFirewallRulesClient("01234567-89ab-4def-0123-456789abcdef", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"ExampleResourceGroup",
		"ExampleWorkspace",
		"ExampleIpFirewallRule",
		armsynapse.IPFirewallRuleInfo{
			Properties: &armsynapse.IPFirewallRuleProperties{
				EndIPAddress:   to.Ptr("10.0.0.254"),
				StartIPAddress: to.Ptr("10.0.0.0"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a firewall rule
 *
 * @summary Creates or updates a firewall rule
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateIpFirewallRule.json
 */
async function createAnIPFirewallRule() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "01234567-89ab-4def-0123-456789abcdef";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "ExampleResourceGroup";
  const workspaceName = "ExampleWorkspace";
  const ruleName = "ExampleIpFirewallRule";
  const ipFirewallRuleInfo = {
    endIpAddress: "10.0.0.254",
    startIpAddress: "10.0.0.0",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.ipFirewallRules.beginCreateOrUpdateAndWait(
    resourceGroupName,
    workspaceName,
    ruleName,
    ipFirewallRuleInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
  }
}

Status code:

201

{
  "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"
  }
}

Status code:

202

Status code:

default

{
  "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	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.

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	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