Admin Rule Collections - List

Servicio:: Network Manager

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

Enumera todas las colecciones de reglas en una configuración de administración de seguridad, en un formato paginado.

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

Con parámetros opcionales:

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
configurationName	path	True	string	Nombre de la configuración de seguridad del administrador de red.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Nombre del administrador 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 API que se usará para la operación.
$skipToken	query		string	SkipToken solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro skipToken que especifica un punto de partida que se usará para las llamadas posteriores.
$top	query		integer (int32) minimum: 1 maximum: 20	Parámetro de consulta opcional que especifica el número máximo de registros que devolverá el servidor.

Respuestas

Nombre	Tipo	Description
200 OK	AdminRuleCollectionListResult	La operación de Azure se completó correctamente.
Other Status Codes	CommonErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AdminRuleCollection	Define la colección de reglas de administración.
AdminRuleCollectionListResult	La respuesta de una operación de lista AdminRuleCollection.
CommonErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
CommonErrorDetail	Detalle del error.
CommonErrorResponse	Respuesta de error
createdByType	Tipo de identidad que creó el recurso.
NetworkManagerSecurityGroupItem	Elemento de grupo de seguridad de Network Manager.
ProvisioningState	Estados de aprovisionamiento de un recurso.
systemData	Metadatos relativos a la creación y última modificación del recurso.

AdminRuleCollection

Objeto

Define la colección de reglas de administración.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.appliesToGroups	NetworkManagerSecurityGroupItem[]	Grupos para la configuración
properties.description	string	Descripción de la colección de reglas de administración.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
properties.resourceGuid	string	Identificador único de este recurso.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso.

AdminRuleCollectionListResult

Objeto

La respuesta de una operación de lista AdminRuleCollection.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	AdminRuleCollection[]	Los elementos de AdminRuleCollection en esta página

CommonErrorAdditionalInfo

Objeto

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

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

CommonErrorDetail

Objeto

Detalle del error.

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

CommonErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	CommonErrorDetail	Objeto de error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

NetworkManagerSecurityGroupItem

Objeto

Elemento de grupo de seguridad de Network Manager.

Nombre	Tipo	Description
networkGroupId	string	Identificador del grupo de Network Manager.

ProvisioningState

Enumeración

Estados de aprovisionamiento de un recurso.

Valor	Description
Failed	Fallido
Succeeded	Succeeded
Canceled	Cancelado
Creating	Creando
Updating	Actualización
Deleting	Eliminando

systemData

Objeto

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)	La 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

Admin Rule Collections - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List security admin rule collections

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdminRuleCollection

AdminRuleCollectionListResult

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

NetworkManagerSecurityGroupItem

ProvisioningState

systemData