Virtual Network Rules - Get

Service:: SQL Database

Version d'API:: 2023-08-01

Obtient une règle de réseau virtuel.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
virtualNetworkRuleName	path	True	string	Nom de la règle de réseau virtuel.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	VirtualNetworkRule	Récupération réussie d’une règle de réseau virtuel spécifiée.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 ResourceNotFound : la ressource demandée est introuvable.

Nom

Type

Description

200 OK

VirtualNetworkRule

Récupération réussie d’une règle de réseau virtuel spécifiée.

Other Status Codes

ErrorResponse

Réponses d’erreur : ***

400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 ResourceNotFound : la ressource demandée est introuvable.

Exemples

Gets a virtual network rule

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule?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/VirtualNetworkRulesGet.json
// this example is just showing the usage of "VirtualNetworkRules_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 SqlServerVirtualNetworkRuleResource created on azure
// for more information of creating SqlServerVirtualNetworkRuleResource, please refer to the document of SqlServerVirtualNetworkRuleResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "vnet-test-svr";
string virtualNetworkRuleName = "vnet-firewall-rule";
ResourceIdentifier sqlServerVirtualNetworkRuleResourceId = SqlServerVirtualNetworkRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, virtualNetworkRuleName);
SqlServerVirtualNetworkRuleResource sqlServerVirtualNetworkRule = client.GetSqlServerVirtualNetworkRuleResource(sqlServerVirtualNetworkRuleResourceId);

// invoke the operation
SqlServerVirtualNetworkRuleResource result = await sqlServerVirtualNetworkRule.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
SqlServerVirtualNetworkRuleData 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

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule",
  "name": "vnet-firewall-rule",
  "type": "Microsoft.Sql/servers/virtualNetworkRules",
  "properties": {
    "ignoreMissingVnetServiceEndpoint": false,
    "state": "Ready",
    "virtualNetworkSubnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet"
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
VirtualNetworkRule	Règle de réseau virtuel.
VirtualNetworkRuleState	État de la règle de réseau virtuel

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

VirtualNetworkRule

Object

Règle de réseau virtuel.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.ignoreMissingVnetServiceEndpoint	boolean	Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé.
properties.state	VirtualNetworkRuleState	État de la règle de réseau virtuel
properties.virtualNetworkSubnetId	string	ID de ressource ARM du sous-réseau de réseau virtuel.
type	string	Type de ressource.

VirtualNetworkRuleState

Énumération

État de la règle de réseau virtuel

Valeur	Description
Initializing
InProgress
Ready
Failed
Deleting
Unknown

Partager via

Virtual Network Rules - Get

Paramètres URI

Réponses

Exemples

Gets a virtual network rule

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

VirtualNetworkRule

VirtualNetworkRuleState