Admin Rule Collections - List

Szolgáltatás:

Network Manager

API-verzió:

2024-05-01

A biztonsági rendszergazdai konfigurációban lévő összes szabálygyűjteményt többoldalas formátumban listázza.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
configurationName	path	True	string	A hálózatkezelő biztonsági konfigurációjának neve.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	A hálózatkezelő neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.
$skipToken	query		string	A SkipToken csak akkor használatos, ha egy korábbi művelet részleges eredményt adott vissza. Ha egy előző válasz tartalmaz nextLink elemet, a nextLink elem értéke tartalmaz egy skipToken paramétert, amely megadja a kezdőpontot a későbbi hívásokhoz.
$top	query		integer (int32) minimum: 1 maximum: 20	Választható lekérdezési paraméter, amely meghatározza a kiszolgáló által visszaadandó rekordok maximális számát.

Válaszok

Name	Típus	Description
200 OK	AdminRuleCollectionListResult	Sikeres lesz. A művelet a megadott biztonsági konfigurációban lévő összes szabálykonfigurációt többoldalas formátumban adja vissza
Other Status Codes	CommonErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List security admin rule collections

Mintakérelem

HTTP

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

Java

/**
 * Samples for AdminRuleCollections List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkManagerAdminRuleCollectionList.json
     */
    /**
     * Sample code: List security admin rule collections.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSecurityAdminRuleCollections(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getAdminRuleCollections().list("rg1", "testNetworkManager",
            "myTestSecurityConfig", null, null, com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_manager_admin_rule_collection_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.admin_rule_collections.list(
        resource_group_name="rg1",
        network_manager_name="testNetworkManager",
        configuration_name="myTestSecurityConfig",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerAdminRuleCollectionList.json
if __name__ == "__main__":
    main()

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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerAdminRuleCollectionList.json
func ExampleAdminRuleCollectionsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAdminRuleCollectionsClient().NewListPager("rg1", "testNetworkManager", "myTestSecurityConfig", &armnetwork.AdminRuleCollectionsClientListOptions{Top: nil,
		SkipToken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AdminRuleCollectionListResult = armnetwork.AdminRuleCollectionListResult{
		// 	Value: []*armnetwork.AdminRuleCollection{
		// 		{
		// 			Name: to.Ptr("testRuleCollection"),
		// 			Type: to.Ptr("Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection"),
		// 			Properties: &armnetwork.AdminRuleCollectionPropertiesFormat{
		// 				Description: to.Ptr("A sample rule collection"),
		// 				AppliesToGroups: []*armnetwork.ManagerSecurityGroupItem{
		// 					{
		// 						NetworkGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup"),
		// 				}},
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 			SystemData: &armnetwork.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * 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/stable/2024-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 (let 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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerAdminRuleCollectionList.json
// this example is just showing the usage of "AdminRuleCollections_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SecurityAdminConfigurationResource created on azure
// for more information of creating SecurityAdminConfigurationResource, please refer to the document of SecurityAdminConfigurationResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string networkManagerName = "testNetworkManager";
string configurationName = "myTestSecurityConfig";
ResourceIdentifier securityAdminConfigurationResourceId = SecurityAdminConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName, configurationName);
SecurityAdminConfigurationResource securityAdminConfiguration = client.GetSecurityAdminConfigurationResource(securityAdminConfigurationResourceId);

// get the collection of this AdminRuleGroupResource
AdminRuleGroupCollection collection = securityAdminConfiguration.GetAdminRuleGroups();

// invoke the operation and iterate over the result
await foreach (AdminRuleGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    AdminRuleGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
AdminRuleCollection	Meghatározza a rendszergazdai szabálygyűjteményt.
AdminRuleCollectionListResult	A biztonsági rendszergazda konfigurációs szabálygyűjteményének eredménye.
CommonErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
CommonErrorDetail	A hiba részletei.
CommonErrorResponse	Hibaválasz
createdByType	Az erőforrást létrehozó identitás típusa.
NetworkManagerSecurityGroupItem	Network Manager biztonsági csoportelem.
ProvisioningState	Erőforrás kiépítési állapotai.
SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AdminRuleCollection

Objektum

Meghatározza a rendszergazdai szabálygyűjteményt.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.appliesToGroups	NetworkManagerSecurityGroupItem[]	Konfigurációs csoportok
properties.description	string	A rendszergazdai szabálygyűjtemény leírása.
properties.provisioningState	ProvisioningState	Az erőforrás kiépítési állapota.
properties.resourceGuid	string	Az erőforrás egyedi azonosítója.
systemData	SystemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Erőforrás típusa.

AdminRuleCollectionListResult

Objektum

A biztonsági rendszergazda konfigurációs szabálygyűjteményének eredménye.

Name	Típus	Description
nextLink	string	Lekéri az URL-címet a következő találatkészlet lekéréséhez.
value	AdminRuleCollection[]	A Network Manager biztonsági rendszergazda konfigurációs szabálygyűjteményeinek listája

CommonErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

CommonErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	CommonErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	CommonErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

CommonErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	CommonErrorDetail	A hibaobjektum.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

NetworkManagerSecurityGroupItem

Objektum

Network Manager biztonsági csoportelem.

Name	Típus	Description
networkGroupId	string	Hálózatkezelő csoportazonosítója.

ProvisioningState

Enumerálás

Erőforrás kiépítési állapotai.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

SystemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.