Admin Rule Collections - List

Tjänst:: Network Manager

API-version:: 2025-05-01

Visar en lista över alla regelsamlingar i en säkerhetsadministratörskonfiguration i sidnumrerat format.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
configurationName	path	True	string	Namnet på nätverkshanterarens säkerhetskonfiguration.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Namnet på nätverkshanteraren.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$skipToken	query		string	SkipToken används endast om en tidigare åtgärd returnerade ett partiellt resultat. Om ett tidigare svar innehåller ett nextLink-element innehåller värdet för nextLink-elementet en skipToken-parameter som anger en startpunkt som ska användas för efterföljande anrop.
$top	query		integer (int32) minimum: 1 maximum: 20	En valfri frågeparameter som anger det maximala antalet poster som ska returneras av servern.

Svar

Name	Typ	Description
200 OK	AdminRuleCollectionListResult	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	CommonErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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"
      }
    }
  ]
}

Definitioner

Name	Description
AdminRuleCollection	Definierar administratörsregelsamlingen.
AdminRuleCollectionListResult	Svaret från en AdminRuleCollection-listaoperation.
CommonErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
CommonErrorDetail	Felinformationen.
CommonErrorResponse	Felsvar
createdByType	Den typ av identitet som skapade resursen.
NetworkManagerSecurityGroupItem	Nätverkshanterarens säkerhetsgruppobjekt.
ProvisioningState	Etableringstillstånd för en resurs.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AdminRuleCollection

Objekt

Definierar administratörsregelsamlingen.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Resursnamn.
properties.appliesToGroups	NetworkManagerSecurityGroupItem[]	Grupper för konfiguration
properties.description	string	En beskrivning av administratörsregelsamlingen.
properties.provisioningState	ProvisioningState	Resursens etableringstillstånd.
properties.resourceGuid	string	Unik identifierare för den här resursen.
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
type	string	Resurstyp.

AdminRuleCollectionListResult

Objekt

Svaret från en AdminRuleCollection-listaoperation.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	AdminRuleCollection[]	AdminRuleCollection-objekten på denna sida

CommonErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

CommonErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	CommonErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	CommonErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

CommonErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	CommonErrorDetail	Felet objektet.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

NetworkManagerSecurityGroupItem

Objekt

Nätverkshanterarens säkerhetsgruppobjekt.

Name	Typ	Description
networkGroupId	string	Grupp-ID för nätverkshanteraren.

ProvisioningState

Uppräkning

Etableringstillstånd för en resurs.

Värde	Description
Failed	Misslyckades
Succeeded	lyckades
Canceled	Annullerad
Creating	Skapar
Updating	Uppdatera
Deleting	Tas bort

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Admin Rule Collections - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

List security admin rule collections

Exempelbegäran

Exempelsvar

Definitioner

AdminRuleCollection

AdminRuleCollectionListResult

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

NetworkManagerSecurityGroupItem

ProvisioningState

systemData