Outbound Firewall Rules - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets an outbound firewall rule.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
outboundRuleFqdn	path	True	string
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	OutboundFirewallRule	Successfully retrieved a specified outbound firewall rule.
Other Status Codes	ErrorResponse	* Error Responses: * 404 ResourceNotFound - The requested resource was not found. 409 OutboundFirewallRuleOngoingOperation - The outbound firewall rule '{0}' for server '{1}' is currently busy with another operation: '{2}' 409 OutboundFirewallRuleLimitReached - Limit of {1} Outbound Firewall Rules for Server {0} has been reached

Name

Type

Description

200 OK

OutboundFirewallRule

Successfully retrieved a specified outbound firewall rule.

Other Status Codes

ErrorResponse

*** Error Responses: ***

404 ResourceNotFound - The requested resource was not found.
409 OutboundFirewallRuleOngoingOperation - The outbound firewall rule '{0}' for server '{1}' is currently busy with another operation: '{2}'
409 OutboundFirewallRuleLimitReached - Limit of {1} Outbound Firewall Rules for Server {0} has been reached

Examples

Gets outbound firewall rule.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/outboundFirewallRules/server.database.windows.net?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/OutboundFirewallRuleGet.json
// this example is just showing the usage of "OutboundFirewallRules_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 OutboundFirewallRuleResource created on azure
// for more information of creating OutboundFirewallRuleResource, please refer to the document of OutboundFirewallRuleResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
string outboundRuleFqdn = "server.database.windows.net";
ResourceIdentifier outboundFirewallRuleResourceId = OutboundFirewallRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, outboundRuleFqdn);
OutboundFirewallRuleResource outboundFirewallRule = client.GetOutboundFirewallRuleResource(outboundFirewallRuleResourceId);

// invoke the operation
OutboundFirewallRuleResource result = await outboundFirewallRule.GetAsync();

// 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
OutboundFirewallRuleData 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": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/outboundFirewallRules/server.datbase.windows.net",
  "name": "server.database.windows.net",
  "type": "Microsoft.Sql/servers/outboundFirewallRules",
  "properties": {
    "provisioningState": "Ready"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OutboundFirewallRule	An Azure SQL DB Server Outbound Firewall Rule.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OutboundFirewallRule

Object

An Azure SQL DB Server Outbound Firewall Rule.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.provisioningState	string	The state of the outbound rule.
type	string	Resource type.

Share via

Outbound Firewall Rules - Get

URI Parameters

Responses

Examples

Gets outbound firewall rule.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OutboundFirewallRule