Firewall Rules - Create Or Update

Service:

Data Lake Analytics

API Version:

2016-11-01

Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}?api-version=2016-11-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the Data Lake Analytics account.
firewallRuleName	path	True	string	The name of the firewall rule to create or update.
resourceGroupName	path	True	string	The name of the Azure resource group.
subscriptionId	path	True	string	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
properties.endIpAddress	True	string	The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
properties.startIpAddress	True	string	The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

Responses

Name	Type	Description
200 OK	FirewallRule	Successfully created or updated the specified firewall rule
Other Status Codes	ErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Creates or updates the specified firewall rule

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla/firewallRules/test_rule?api-version=2016-11-01

{
  "properties": {
    "startIpAddress": "1.1.1.1",
    "endIpAddress": "2.2.2.2"
  }
}

Java

/** Samples for FirewallRules CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/FirewallRules_CreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates the specified firewall rule.
     *
     * @param manager Entry point to DataLakeAnalyticsManager.
     */
    public static void createsOrUpdatesTheSpecifiedFirewallRule(
        com.azure.resourcemanager.datalakeanalytics.DataLakeAnalyticsManager manager) {
        manager
            .firewallRules()
            .define("test_rule")
            .withExistingAccount("contosorg", "contosoadla")
            .withStartIpAddress("1.1.1.1")
            .withEndIpAddress("2.2.2.2")
            .create();
    }
}

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

dotnet

using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataLakeAnalytics;
using Azure.ResourceManager.DataLakeAnalytics.Models;

// Generated from example definition: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/FirewallRules_CreateOrUpdate.json
// this example is just showing the usage of "FirewallRules_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataLakeAnalyticsAccountResource created on azure
// for more information of creating DataLakeAnalyticsAccountResource, please refer to the document of DataLakeAnalyticsAccountResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "contosorg";
string accountName = "contosoadla";
ResourceIdentifier dataLakeAnalyticsAccountResourceId = DataLakeAnalyticsAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
DataLakeAnalyticsAccountResource dataLakeAnalyticsAccount = client.GetDataLakeAnalyticsAccountResource(dataLakeAnalyticsAccountResourceId);

// get the collection of this DataLakeAnalyticsFirewallRuleResource
DataLakeAnalyticsFirewallRuleCollection collection = dataLakeAnalyticsAccount.GetDataLakeAnalyticsFirewallRules();

// invoke the operation
string firewallRuleName = "test_rule";
DataLakeAnalyticsFirewallRuleCreateOrUpdateContent content = new DataLakeAnalyticsFirewallRuleCreateOrUpdateContent(IPAddress.Parse("1.1.1.1"), IPAddress.Parse("2.2.2.2"));
ArmOperation<DataLakeAnalyticsFirewallRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, firewallRuleName, content);
DataLakeAnalyticsFirewallRuleResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataLakeAnalyticsFirewallRuleData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
  "name": "test_rule",
  "type": "test_type",
  "properties": {
    "startIpAddress": "1.1.1.1",
    "endIpAddress": "2.2.2.2"
  }
}

Definitions

Name	Description
CreateOrUpdateFirewallRuleParameters	The parameters used to create a new firewall rule.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FirewallRule	Data Lake Analytics firewall rule information.

CreateOrUpdateFirewallRuleParameters

The parameters used to create a new firewall rule.

Name	Type	Description
properties.endIpAddress	string	The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
properties.startIpAddress	string	The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.

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.

FirewallRule

Data Lake Analytics firewall rule information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.endIpAddress	string	The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
properties.startIpAddress	string	The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
type	string	The resource type.