Freigeben über


Network Security Perimeter - Get Configuration

Ruft Informationen zur angegebenen NSP-Konfiguration ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2024-07-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

Der Name des Batchkontos.

networkSecurityPerimeterConfigurationName
path True

string

pattern: ^.*$

Der Name für die Netzwerksicherheitsperimeterkonfiguration

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die das Batchkonto enthält.

subscriptionId
path True

string

Die Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-0000000000000)

api-version
query True

string

Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

NetworkSecurityPerimeterConfiguration

Der Vorgang war erfolgreich. Die Antwort enthält die NSP-Konfiguration.

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

GetNspConfiguration

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation?api-version=2024-07-01

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation",
  "name": "00000000-0000-0000-0000-000000000000.sampleassociation",
  "type": "Microsoft.Batch/batchAccounts/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Succeeded",
    "provisioningIssues": [],
    "networkSecurityPerimeter": {
      "id": "/subscriptions/perimeterSubscriptionId/resourceGroups/perimeterResourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeterName",
      "perimeterGuid": "00000000-0000-0000-0000-000000000000",
      "location": "perimeterLocation"
    },
    "resourceAssociation": {
      "name": "sampleassociation",
      "accessMode": "Learning"
    },
    "profile": {
      "name": "profileName",
      "accessRulesVersion": 1,
      "accessRules": [
        {
          "name": "accessRule1",
          "properties": {
            "direction": "Inbound",
            "addressPrefixes": [
              "10.11.0.0/16",
              "10.10.1.0/24"
            ],
            "fullyQualifiedDomainNames": [],
            "subscriptions": [],
            "networkSecurityPerimeters": [],
            "emailAddresses": [],
            "phoneNumbers": []
          }
        },
        {
          "name": "accessRule2",
          "properties": {
            "direction": "Outbound",
            "addressPrefixes": [],
            "fullyQualifiedDomainNames": [
              "paasrp1.contoso.org",
              "paasrp2.contoso.org"
            ],
            "subscriptions": [],
            "networkSecurityPerimeters": [],
            "emailAddresses": [],
            "phoneNumbers": []
          }
        }
      ],
      "diagnosticSettingsVersion": 1,
      "enabledLogCategories": [
        "logCategory1",
        "logCategory2"
      ]
    }
  }
}

Definitionen

Name Beschreibung
AccessRule

Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil

AccessRuleDirection

Richtung der Zugriffsregel

AccessRuleProperties

Eigenschaften der Access-Regel

CloudError

Eine Fehlerantwort des Batchdiensts.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

IssueType

Art des Problems

NetworkSecurityPerimeter

Informationen zu einem Netzwerksicherheitsperimeter (NSP)

NetworkSecurityPerimeterConfiguration

Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource

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

Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil

Name Typ Beschreibung
name

string

Name der Zugriffsregel

properties

AccessRuleProperties

Eigenschaften der Access-Regel

AccessRuleDirection

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

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

CloudError

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Der Textkörper der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

IssueType

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

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

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, die createdBy- und modifiedBy-Informationen enthalten.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

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

Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.

Wert Beschreibung
Accepted
Canceled
Creating
Deleting
Failed
Succeeded
Updating

NetworkSecurityProfile

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

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

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

Informationen zur Ressourcenzuordnung

Name Typ Beschreibung
accessMode

ResourceAssociationAccessMode

Zugriffsmodus der Ressourcenzuordnung

name

string

Name der Ressourcenzuordnung

ResourceAssociationAccessMode

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

Schweregrad des Problems.

Wert Beschreibung
Error
Warning

Subscriptions

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

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.