Firewall Rules - Get

Service:

Data Lake Analytics

API Version:

2016-11-01

Gets the specified Data Lake Analytics firewall rule.

GET 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 retrieve.
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.

Responses

Name	Type	Description
200 OK	FirewallRule	Successfully retrieved 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

Gets the specified Data Lake Analytics firewall rule

Sample Request

HTTP

GET 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

Java

/** Samples for FirewallRules Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/FirewallRules_Get.json
     */
    /**
     * Sample code: Gets the specified Data Lake Analytics firewall rule.
     *
     * @param manager Entry point to DataLakeAnalyticsManager.
     */
    public static void getsTheSpecifiedDataLakeAnalyticsFirewallRule(
        com.azure.resourcemanager.datalakeanalytics.DataLakeAnalyticsManager manager) {
        manager
            .firewallRules()
            .getWithResponse("contosorg", "contosoadla", "test_rule", com.azure.core.util.Context.NONE);
    }
}

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_Get.json
// this example is just showing the usage of "FirewallRules_Get" 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";
NullableResponse<DataLakeAnalyticsFirewallRuleResource> response = await collection.GetIfExistsAsync(firewallRuleName);
DataLakeAnalyticsFirewallRuleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FirewallRule	Data Lake Analytics firewall rule information.

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.