Network Security Perimeter Configurations - List

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2025-05-01-preview

Ruft eine Liste der effektiven Netzwerksicherheitsperimeterkonfiguration für cosmos db-Konto ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	NetworkSecurityPerimeterConfigurationListResult	Netzwerksicherheitsperimeterkonfigurationsliste
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

NamspaceNetworkSecurityPerimeterConfigurationList

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations?api-version=2025-05-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "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": "association1",
          "accessMode": "Enforced"
        },
        "profile": {
          "name": "profile1",
          "accessRulesVersion": 10,
          "accessRules": [
            {
              "name": "inVpnRule",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8",
                  "152.4.6.0/24"
                ]
              }
            }
          ],
          "diagnosticSettingsVersion": 5,
          "enabledLogCategories": [
            "NspPublicInboundPerimeterRulesAllowed",
            "NspPublicInboundPerimeterRulesDenied"
          ]
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AccessRule	Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil
AccessRuleDirection	Richtung der Zugriffsregel
AccessRuleProperties	Eigenschaften der Access-Regel
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IssueType	Art des Problems
NetworkSecurityPerimeter	Informationen zu einem Netzwerksicherheitsperimeter (NSP)
NetworkSecurityPerimeterConfiguration	Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource
NetworkSecurityPerimeterConfigurationListResult	Ergebnis einer NSP-Konfigurationsanforderung (Netzwerksicherheitsperimeter).
NetworkSecurityPerimeterConfigurationProperties	Netzwerksicherheitskonfigurationseigenschaften.
NetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.
NetworkSecurityProfile	Netzwerksicherheitsperimeterkonfigurationsprofil
ProvisioningIssue	Beschreibt ein Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration
ProvisioningIssueProperties	Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.
ResourceAssociation	Informationen zur Ressourcenzuordnung
ResourceAssociationAccessMode	Zugriffsmodus der Ressourcenzuordnung
Severity	Schweregrad des Problems.
Subscriptions	Abonnements für eingehende Regeln
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRule

Objekt

Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil

Name	Typ	Beschreibung
name	string	Name der Zugriffsregel
properties	AccessRuleProperties	Eigenschaften der Access-Regel

AccessRuleDirection

Enumeration

Richtung der Zugriffsregel

Wert	Beschreibung
Inbound	Gilt für eingehenden Netzwerkdatenverkehr für die gesicherten Ressourcen.
Outbound	Gilt für ausgehenden Netzwerkdatenverkehr von den gesicherten Ressourcen

AccessRuleProperties

Objekt

Eigenschaften der Access-Regel

Name	Typ	Beschreibung
addressPrefixes	string[]	Adresspräfixe im CIDR-Format für eingehende Regeln
direction	AccessRuleDirection	Richtung der Zugriffsregel
emailAddresses	string[]	E-Mail-Adressen für ausgehende Regeln
fullyQualifiedDomainNames	string[]	Vollqualifizierte Domänennamen (FQDN) für ausgehende Regeln
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Netzwerksicherheitsperimeter für eingehende Regeln
phoneNumbers	string[]	Telefonnummern für ausgehende Regeln
subscriptions	Subscriptions[]	Abonnements für eingehende Regeln

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IssueType

Enumeration

Art des Problems

Wert	Beschreibung
ConfigurationPropagationFailure	Fehler beim Anwenden der Netzwerksicherheitsperimeterkonfiguration (NSP).
MissingIdentityConfiguration	Eine verwaltete Identität wurde der Ressource nicht zugeordnet. Die Ressource kann weiterhin eingehenden Datenverkehr vom Netzwerksicherheitsperimeter (NSP) oder übereinstimmenden Regeln für eingehenden Zugriff überprüfen, kann jedoch keinen ausgehenden Zugriff als Mitglied des NSP ausführen.
MissingPerimeterConfiguration	Ein Netzwerkkonnektivitätsproblem tritt auf der Ressource auf, die behoben werden kann, indem dem Netzwerksicherheitsperimeter (Network Security Perimeter, NSP) neue Ressourcen hinzugefügt werden, oder durch Ändern von Zugriffsregeln.
Unknown	Unbekannter Problemtyp

NetworkSecurityPerimeter

Objekt

Informationen zu einem Netzwerksicherheitsperimeter (NSP)

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Azure-Ressourcen-ID der NSP-Ressource
location	string	Speicherort des Netzwerksicherheitsperimeters
perimeterGuid	string (uuid)	Universelle eindeutige ID (UUID) des Netzwerksicherheitsperimeters

NetworkSecurityPerimeterConfiguration

Objekt

Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	NetworkSecurityPerimeterConfigurationProperties	Netzwerksicherheitskonfigurationseigenschaften.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationListResult

Objekt

Ergebnis einer NSP-Konfigurationsanforderung (Netzwerksicherheitsperimeter).

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link, der zum Abrufen der nächsten Seite der Ergebnisse verwendet wird.
value	NetworkSecurityPerimeterConfiguration[]	Array von Netzwerksicherheitsperimeterergebnissen.

NetworkSecurityPerimeterConfigurationProperties

Objekt

Netzwerksicherheitskonfigurationseigenschaften.

Name	Typ	Beschreibung
networkSecurityPerimeter	NetworkSecurityPerimeter	Informationen zu einem Netzwerksicherheitsperimeter (NSP)
profile	NetworkSecurityProfile	Netzwerksicherheitsperimeterkonfigurationsprofil
provisioningIssues	ProvisioningIssue[]	Liste der Bereitstellungsprobleme, falls vorhanden
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.
resourceAssociation	ResourceAssociation	Informationen zur Ressourcenzuordnung

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeration

Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.

Wert	Beschreibung
Accepted
Canceled
Creating
Deleting
Failed
Succeeded
Updating

NetworkSecurityProfile

Objekt

Netzwerksicherheitsperimeterkonfigurationsprofil

Name	Typ	Beschreibung
accessRules	AccessRule[]	Liste der Zugriffsregeln
accessRulesVersion	integer (int32)	Aktuelle Version der Zugriffsregeln
diagnosticSettingsVersion	integer (int32)	Aktuelle Diagnoseeinstellungsversion
enabledLogCategories	string[]	Liste der aktivierten Protokollkategorien
name	string	Name des Profils

ProvisioningIssue

Objekt

Beschreibt ein Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration

Name	Typ	Beschreibung
name	string	Name des Problems
properties	ProvisioningIssueProperties	Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.

ProvisioningIssueProperties

Objekt

Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.

Name	Typ	Beschreibung
description	string	Beschreibung des Problems
issueType	IssueType	Art des Problems
severity	Severity	Schweregrad des Problems.
suggestedAccessRules	AccessRule[]	Zugriffsregeln, die dem Netzwerksicherheitsprofil (Network Security Profile, NSP) hinzugefügt werden können, um das Problem zu beheben.
suggestedResourceIds	string[] (arm-id)	Vollqualifizierte Ressourcen-IDs vorgeschlagener Ressourcen, die dem Netzwerksicherheitsperimeter (NSP) zugeordnet werden können, um das Problem zu beheben.

ResourceAssociation

Objekt

Informationen zur Ressourcenzuordnung

Name	Typ	Beschreibung
accessMode	ResourceAssociationAccessMode	Zugriffsmodus der Ressourcenzuordnung
name	string	Name der Ressourcenzuordnung

ResourceAssociationAccessMode

Enumeration

Zugriffsmodus der Ressourcenzuordnung

Wert	Beschreibung
Audit	Überwachungszugriffsmodus – Datenverkehr zu der Ressource, bei der Zugriffsprüfungen fehlschlägt, wird protokolliert, aber nicht blockiert.
Enforced	Erzwungener Zugriffsmodus – Datenverkehr zu der Ressource, für die Zugriffsprüfungen fehlgeschlagen sind, wird blockiert.
Learning	Lernzugriffsmodus – Datenverkehr zur Ressource ist für die Analyse aktiviert, aber nicht blockiert.

Severity

Enumeration

Schweregrad des Problems.

Wert	Beschreibung
Error
Warning

Subscriptions

Objekt

Abonnements für eingehende Regeln

Name	Typ	Beschreibung
id	string (arm-id)	Die vollqualifizierte Azure-Ressourcen-ID des Abonnements, z. B. ('/subscriptions/0000000-00000-0000-00000-0000000000')

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Network Security Perimeter Configurations - List

URI-Parameter

Antworten

Beispiele

NamspaceNetworkSecurityPerimeterConfigurationList

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AccessRule

AccessRuleDirection

AccessRuleProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IssueType

NetworkSecurityPerimeter

NetworkSecurityPerimeterConfiguration

NetworkSecurityPerimeterConfigurationListResult

NetworkSecurityPerimeterConfigurationProperties

NetworkSecurityPerimeterConfigurationProvisioningState

NetworkSecurityProfile

ProvisioningIssue

ProvisioningIssueProperties

ResourceAssociation

ResourceAssociationAccessMode

Severity

Subscriptions

systemData