Network Security Perimeter Configurations - Get

Referencia

Servicio:: Cosmos DB Resource Provider

Versión de la API:: 2025-05-01-preview

Obtiene la configuración perimetral de seguridad de red efectiva para la asociación.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2025-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nombre de la cuenta de base de datos de Cosmos DB.
networkSecurityPerimeterConfigurationName	path	True	string pattern: ^.*$	Nombre de la configuración perimetral de seguridad de red
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	NetworkSecurityPerimeterConfiguration	Configuración perimetral de seguridad de red
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

NamspaceNetworkSecurityPerimeterConfigurationList

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1?api-version=2025-05-01-preview

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "name": "dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "type": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Succeeded",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/res4794/providers/Microsoft.Network/networkSecurityPerimeters/nsp1",
      "perimeterGuid": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5",
      "location": "East US"
    },
    "resourceAssociation": {
      "name": "resourceAssociation1",
      "accessMode": "Enforced"
    },
    "profile": {
      "name": "profile1",
      "accessRulesVersion": 10,
      "accessRules": [
        {
          "name": "allowedSubscriptions",
          "properties": {
            "direction": "Inbound",
            "subscriptions": [
              {
                "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774"
              }
            ]
          }
        }
      ],
      "diagnosticSettingsVersion": 5,
      "enabledLogCategories": [
        "NspPublicInboundPerimeterRulesAllowed",
        "NspPublicInboundPerimeterRulesDenied"
      ]
    }
  }
}

Definiciones

Nombre	Description
AccessRule	Regla de acceso en un perfil de configuración perimetral de seguridad de red
AccessRuleDirection	Dirección de la regla de acceso
AccessRuleProperties	Propiedades de la regla de acceso
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IssueType	Tipo de problema
NetworkSecurityPerimeter	Información sobre un perímetro de seguridad de red (NSP)
NetworkSecurityPerimeterConfiguration	Recurso de configuración del perímetro de seguridad de red (NSP)
NetworkSecurityPerimeterConfigurationProperties	Propiedades de configuración de seguridad de red.
NetworkSecurityPerimeterConfigurationProvisioningState	Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.
NetworkSecurityProfile	Perfil de configuración perimetral de seguridad de red
ProvisioningIssue	Describe un problema de aprovisionamiento para una configuración perimetral de seguridad de red.
ProvisioningIssueProperties	Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.
ResourceAssociation	Información sobre la asociación de recursos
ResourceAssociationAccessMode	Modo de acceso de la asociación de recursos
Severity	Gravedad del problema.
Subscriptions	Suscripciones para reglas de entrada
systemData	Metadatos relativos a la creación y última modificación del recurso.

AccessRule

Object

Regla de acceso en un perfil de configuración perimetral de seguridad de red

Nombre	Tipo	Description
name	string	Nombre de la regla de acceso
properties	AccessRuleProperties	Propiedades de la regla de acceso

AccessRuleDirection

Enumeración

Dirección de la regla de acceso

Valor	Description
Inbound	Se aplica al tráfico de red entrante a los recursos protegidos.
Outbound	Se aplica al tráfico de red saliente de los recursos protegidos.

AccessRuleProperties

Object

Propiedades de la regla de acceso

Nombre	Tipo	Description
addressPrefixes	string[]	Prefijos de dirección en el formato CIDR para las reglas de entrada
direction	AccessRuleDirection	Dirección de la regla de acceso
emailAddresses	string[]	Direcciones de correo electrónico para reglas de salida
fullyQualifiedDomainNames	string[]	Nombres de dominio completos (FQDN) para reglas de salida
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Perímetros de seguridad de red para reglas de entrada
phoneNumbers	string[]	Números de teléfono para reglas de salida
subscriptions	Subscriptions[]	Suscripciones para reglas de entrada

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IssueType

Enumeración

Tipo de problema

Valor	Description
ConfigurationPropagationFailure	Error al aplicar la configuración del perímetro de seguridad de red (NSP).
MissingIdentityConfiguration	Una identidad administrada no se ha asociado al recurso. El recurso seguirá siendo capaz de validar el tráfico entrante desde el perímetro de seguridad de red (NSP) o las reglas de acceso entrantes coincidentes, pero no podrá realizar el acceso saliente como miembro del NSP.
MissingPerimeterConfiguration	Se produce un problema de conectividad de red en el recurso que podría solucionarse agregando nuevos recursos al perímetro de seguridad de red (NSP) o modificando las reglas de acceso.
Unknown	Tipo de problema desconocido

NetworkSecurityPerimeter

Object

Información sobre un perímetro de seguridad de red (NSP)

Nombre	Tipo	Description
id	string (arm-id)	Identificador completo de recurso de Azure del recurso de NSP
location	string	Ubicación del perímetro de seguridad de red
perimeterGuid	string (uuid)	Identificador único universal (UUID) del perímetro de seguridad de red

NetworkSecurityPerimeterConfiguration

Object

Recurso de configuración del perímetro de seguridad de red (NSP)

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties	NetworkSecurityPerimeterConfigurationProperties	Propiedades de configuración de seguridad de red.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Object

Propiedades de configuración de seguridad de red.

Nombre	Tipo	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Información sobre un perímetro de seguridad de red (NSP)
profile	NetworkSecurityProfile	Perfil de configuración perimetral de seguridad de red
provisioningIssues	ProvisioningIssue[]	Lista de problemas de aprovisionamiento, si los hay
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.
resourceAssociation	ResourceAssociation	Información sobre la asociación de recursos

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeración

Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.

Valor	Description
Accepted
Canceled
Creating
Deleting
Failed
Succeeded
Updating

NetworkSecurityProfile

Object

Perfil de configuración perimetral de seguridad de red

Nombre	Tipo	Description
accessRules	AccessRule[]	Lista de reglas de acceso
accessRulesVersion	integer (int32)	Versión actual de las reglas de acceso
diagnosticSettingsVersion	integer (int32)	Versión actual de la configuración de diagnóstico
enabledLogCategories	string[]	Lista de categorías de registro habilitadas
name	string	Nombre del perfil

ProvisioningIssue

Object

Describe un problema de aprovisionamiento para una configuración perimetral de seguridad de red.

Nombre	Tipo	Description
name	string	Nombre del problema
properties	ProvisioningIssueProperties	Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.

ProvisioningIssueProperties

Object

Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.

Nombre	Tipo	Description
description	string	Descripción del problema
issueType	IssueType	Tipo de problema
severity	Severity	Gravedad del problema.
suggestedAccessRules	AccessRule[]	Reglas de acceso que se pueden agregar al perfil de seguridad de red (NSP) para corregir el problema.
suggestedResourceIds	string[] (arm-id)	Identificadores de recursos completos de recursos sugeridos que se pueden asociar al perímetro de seguridad de red (NSP) para corregir el problema.

ResourceAssociation

Object

Información sobre la asociación de recursos

Nombre	Tipo	Description
accessMode	ResourceAssociationAccessMode	Modo de acceso de la asociación de recursos
name	string	Nombre de la asociación de recursos

ResourceAssociationAccessMode

Enumeración

Modo de acceso de la asociación de recursos

Valor	Description
Audit	Modo de acceso de auditoría: el tráfico al recurso que produce un error en las comprobaciones de acceso se registra, pero no está bloqueado.
Enforced	Modo de acceso aplicado: se bloquea el tráfico al recurso que produjo un error en las comprobaciones de acceso.
Learning	Modo de acceso de aprendizaje: el tráfico al recurso está habilitado para el análisis, pero no bloqueado

Severity

Enumeración

Gravedad del problema.

Valor	Description
Error
Warning

Subscriptions

Object

Suscripciones para reglas de entrada

Nombre	Tipo	Description
id	string (arm-id)	El identificador de recurso completo de Azure de la suscripción, por ejemplo('/subscriptions/000000000-00000-0000-00000-0000000000000')

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Network Security Perimeter Configurations - Get

Parámetros de identificador URI

Respuestas

Ejemplos

NamspaceNetworkSecurityPerimeterConfigurationList

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AccessRule

AccessRuleDirection

AccessRuleProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IssueType

NetworkSecurityPerimeter

NetworkSecurityPerimeterConfiguration

NetworkSecurityPerimeterConfigurationProperties

NetworkSecurityPerimeterConfigurationProvisioningState

NetworkSecurityProfile

ProvisioningIssue

ProvisioningIssueProperties

ResourceAssociation

ResourceAssociationAccessMode

Severity

Subscriptions

systemData