Network Security Perimeter Configurations - Get

Service:: Search Management

Version d’API:: 2025-02-01-preview

Obtient une configuration de périmètre de sécurité réseau.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}?api-version=2025-02-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
nspConfigName	path	True	string minLength: 38 maxLength: 100 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\.[a-z][a-z0-9]*$	Nom de la configuration de la sécurité réseau.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nom du service Recherche IA Azure associé au groupe de ressources spécifié.
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
api-version	query	True	string	Version de l’API à utiliser pour chaque requête.

Réponses

Nom	Type	Description
200 OK	NetworkSecurityPerimeterConfiguration	Récupération réussie de la configuration.
Other Status Codes	CloudError	Une erreur inattendue s’est produite pendant l’opération.

Sécurité

azure_auth

Spécifie un flux d’octroi implicite, tel qu’il est pris en charge sur la plateforme Microsoft Identity.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get an NSP config by name

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-02-01-preview

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Accepted",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    },
    "profile": {
      "name": "profile1",
      "accessRulesVersion": "0",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "direction": "Inbound",
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ]
          }
        }
      ]
    }
  }
}

Définitions

Nom	Description
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
NetworkSecurityPerimeterConfiguration	Configuration du périmètre de sécurité réseau pour un serveur.
NSPConfigAccessRule	Règle d’accès pour une configuration de périmètre de sécurité réseau.
NSPConfigAccessRuleProperties	Propriétés des règles d’accès dans une configuration de périmètre de sécurité réseau.
NSPConfigAssociation	Association de ressources pour le périmètre de sécurité réseau.
NSPConfigNetworkSecurityPerimeterRule	Propriétés du périmètre de sécurité réseau présentes dans une règle de configuration.
NSPConfigPerimeter	Périmètre d’une configuration de périmètre de sécurité réseau.
NSPConfigProfile	Profil d’une configuration de périmètre de sécurité réseau.
NSPProvisioningIssue	Objet qui décrit les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.
NSPProvisioningIssueProperties	Propriétés permettant de décrire les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.

CloudError

Objet

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
message	string	Brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.message »).

CloudErrorBody

Objet

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit en détail l’erreur et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

NetworkSecurityPerimeterConfiguration

Objet

Configuration du périmètre de sécurité réseau pour un serveur.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.networkSecurityPerimeter	NSPConfigPerimeter	Périmètre d’une configuration de périmètre de sécurité réseau.
properties.profile	NSPConfigProfile	Profil d’une configuration de périmètre de sécurité réseau.
properties.provisioningIssues	NSPProvisioningIssue[]	Objet qui décrit les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	Association de ressources pour le périmètre de sécurité réseau.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

NSPConfigAccessRule

Objet

Règle d’accès pour une configuration de périmètre de sécurité réseau.

Nom	Type	Description
name	string
properties	NSPConfigAccessRuleProperties	Propriétés des règles d’accès dans une configuration de périmètre de sécurité réseau.

NSPConfigAccessRuleProperties

Objet

Propriétés des règles d’accès dans une configuration de périmètre de sécurité réseau.

Nom	Type	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	Propriétés du périmètre de sécurité réseau présentes dans une règle de configuration.
subscriptions	string[]

NSPConfigAssociation

Objet

Association de ressources pour le périmètre de sécurité réseau.

Nom	Type	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Objet

Propriétés du périmètre de sécurité réseau présentes dans une règle de configuration.

Nom	Type	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Objet

Périmètre d’une configuration de périmètre de sécurité réseau.

Nom	Type	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Objet

Profil d’une configuration de périmètre de sécurité réseau.

Nom	Type	Description
accessRules	NSPConfigAccessRule[]	Règle d’accès pour une configuration de périmètre de sécurité réseau.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Objet

Objet qui décrit les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.

Nom	Type	Description
name	string
properties	NSPProvisioningIssueProperties	Propriétés permettant de décrire les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.

NSPProvisioningIssueProperties

Objet

Propriétés permettant de décrire les problèmes liés à l’approvisionnement de périmètres de sécurité réseau à un service de recherche.

Nom	Type	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]