Admin Rule Collections - List

Dienst:: Network Manager

API-Version:: 2025-05-01

Listet alle Regelsammlungen in einer Sicherheitsadministratorkonfiguration in einem paginierten Format auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections?api-version=2025-05-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections?api-version=2025-05-01&$top={$top}&$skipToken={$skipToken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
configurationName	path	True	string	Der Name der Netzwerk-Manager-Sicherheitskonfiguration.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Der Name des Netzwerk-Managers.
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	Die API-Version, die für diesen Vorgang verwendet werden soll.
$skipToken	query		string	SkipToken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen skipToken-Parameter, der einen Ausgangspunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.
$top	query		integer (int32) minimum: 1 maximum: 20	Ein optionaler Abfrageparameter, der die maximale Anzahl von Datensätzen angibt, die vom Server zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	AdminRuleCollectionListResult	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CommonErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List security admin rule collections

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections?api-version=2025-05-01

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all the rule collections in a security admin configuration, in a paginated format.
 *
 * @summary Lists all the rule collections in a security admin configuration, in a paginated format.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkManagerAdminRuleCollectionList.json
 */
async function listSecurityAdminRuleCollections() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "testNetworkManager";
  const configurationName = "myTestSecurityConfig";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.adminRuleCollections.list(
    resourceGroupName,
    networkManagerName,
    configurationName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections?api-version=2025-05-01&$skipToken=10",
  "value": [
    {
      "name": "testRuleCollection",
      "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection",
      "properties": {
        "description": "A sample rule collection",
        "appliesToGroups": [
          {
            "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup"
          }
        ],
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-000000000000"
      },
      "systemData": {
        "createdAt": "2021-01-11T18:52:27Z",
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "createdByType": "User",
        "lastModifiedAt": "2021-01-11T18:52:27Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "lastModifiedByType": "User"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AdminRuleCollection	Definiert die Administratorregelsammlung.
AdminRuleCollectionListResult	Die Antwort einer AdminRuleCollection-Listenoperation.
CommonErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
CommonErrorDetail	Das Fehlerdetails.
CommonErrorResponse	Fehlerantwort
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
NetworkManagerSecurityGroupItem	Sicherheitsgruppenelement des Netzwerk-Managers.
ProvisioningState	Bereitstellungszustände einer Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AdminRuleCollection

Objekt

Definiert die Administratorregelsammlung.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.appliesToGroups	NetworkManagerSecurityGroupItem[]	Gruppen für die Konfiguration
properties.description	string	Eine Beschreibung der Administratorregelsammlung.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Ressource.
properties.resourceGuid	string	Eindeutiger Bezeichner für diese Ressource.
systemData	systemData	Die Systemmetadaten im Zusammenhang mit dieser Ressource.
type	string	Ressourcentyp.

AdminRuleCollectionListResult

Objekt

Die Antwort einer AdminRuleCollection-Listenoperation.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	AdminRuleCollection[]	Die AdminRuleCollection-Artikel auf dieser Seite

CommonErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

CommonErrorDetail

Objekt

Das Fehlerdetails.

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

CommonErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	CommonErrorDetail	Das Fehlerobjekt.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

NetworkManagerSecurityGroupItem

Objekt

Sicherheitsgruppenelement des Netzwerk-Managers.

Name	Typ	Beschreibung
networkGroupId	string	Gruppen-ID des Netzwerk-Managers.

ProvisioningState

Enumeration

Bereitstellungszustände einer Ressource.

Wert	Beschreibung
Failed	gescheitert
Succeeded	Erfolgreich
Canceled	Abgesagt
Creating	Erstellen
Updating	Aktualisieren
Deleting	Löschen

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

Admin Rule Collections - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List security admin rule collections

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdminRuleCollection

AdminRuleCollectionListResult

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

NetworkManagerSecurityGroupItem

ProvisioningState

systemData