Admin Rule Collections - List

Serviço:: Network Manager

Versão da API:: 2025-05-01

Lista todas as coleções de regras em uma configuração de administrador de segurança, em um formato paginado.

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

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
configurationName	path	True	string	O nome da Configuração de Segurança do gerenciador de rede.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do gerenciador de rede.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$skipToken	query		string	SkipToken só será usado se uma operação anterior retornar um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skipToken que especifica um ponto de partida a ser usado para chamadas subsequentes.
$top	query		integer (int32) minimum: 1 maximum: 20	Um parâmetro de consulta opcional que especifica o número máximo de registros a serem retornados pelo servidor.

Respostas

Nome	Tipo	Description
200 OK	AdminRuleCollectionListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CommonErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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"
      }
    }
  ]
}

Definições

Nome	Description
AdminRuleCollection	Define a coleção de regras de administrador.
AdminRuleCollectionListResult	A resposta de uma operação de lista AdminRuleCollection.
CommonErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
CommonErrorDetail	O detalhe do erro.
CommonErrorResponse	Resposta de erro
createdByType	O tipo de identidade que criou o recurso.
NetworkManagerSecurityGroupItem	Item do grupo de segurança do gerenciador de rede.
ProvisioningState	Provisionando estados de um recurso.
systemData	Metadados relativos à criação e última modificação do recurso.

AdminRuleCollection

Objeto

Define a coleção de regras de administrador.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.appliesToGroups	NetworkManagerSecurityGroupItem[]	Grupos para configuração
properties.description	string	Uma descrição da coleção de regras de administrador.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso.
properties.resourceGuid	string	Identificador exclusivo para esse recurso.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo de recurso.

AdminRuleCollectionListResult

Objeto

A resposta de uma operação de lista AdminRuleCollection.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	AdminRuleCollection[]	Os itens da AdminRuleCollection nesta página

CommonErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

CommonErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	CommonErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CommonErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommonErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	CommonErrorDetail	O objeto de erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

NetworkManagerSecurityGroupItem

Objeto

Item do grupo de segurança do gerenciador de rede.

Nome	Tipo	Description
networkGroupId	string	ID do grupo do gerenciador de rede.

ProvisioningState

Enumeração

Provisionando estados de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criando
Updating	Atualização
Deleting	Excluir

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Admin Rule Collections - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List security admin rule collections

Solicitação de exemplo

Resposta de exemplo

Definições

AdminRuleCollection

AdminRuleCollectionListResult

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

NetworkManagerSecurityGroupItem

ProvisioningState

systemData