Network Security Perimeter Associable Resource Types - List

Служба:

Network security perimeter

Версия API:

2024-07-01

Возвращает список ресурсов, подключенных к NSP. Эти ресурсы можно связать с периметром безопасности сети

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes?api-version=2024-07-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
location	path	True	string	Расположение периметра безопасности сети.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	PerimeterAssociableResourcesListResult	Запрос успешно выполнен. Возвращает список ресурсов, подключенных с функцией периметра безопасности сети.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

NetworkSecurityPerimeterAssociableResourceTypes

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/locations/westus/perimeterAssociableResourceTypes?api-version=2024-07-01

Java

/**
 * Samples for NetworkSecurityPerimeterAssociableResourceTypes List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/
     * PerimeterAssociableResourcesList.json
     */
    /**
     * Sample code: NetworkSecurityPerimeterAssociableResourceTypes.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        networkSecurityPerimeterAssociableResourceTypes(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkSecurityPerimeterAssociableResourceTypes().list("westus",
            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 perimeter_associable_resources_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="subId",
    )

    response = client.network_security_perimeter_associable_resource_types.list(
        location="westus",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/PerimeterAssociableResourcesList.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c58fa033619b12c7cfa8a0ec5a9bf03bb18869ab/specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/PerimeterAssociableResourcesList.json
func ExampleSecurityPerimeterAssociableResourceTypesClient_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.NewSecurityPerimeterAssociableResourceTypesClient().NewListPager("westus", 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.PerimeterAssociableResourcesListResult = armnetwork.PerimeterAssociableResourcesListResult{
		// 	Value: []*armnetwork.PerimeterAssociableResource{
		// 		{
		// 			Name: to.Ptr("Microsoft.Sql.servers"),
		// 			Type: to.Ptr("Microsoft.Network/PerimeterAssociableResourceTypes"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionID}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Sql.servers"),
		// 			Properties: &armnetwork.PerimeterAssociableResourceProperties{
		// 				DisplayName: to.Ptr("Microsoft.Sql/servers"),
		// 				PublicDNSZones: []*string{
		// 					to.Ptr("database.windows.net")},
		// 					ResourceType: to.Ptr("Microsoft.Sql/servers"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("Microsoft.Storage.accounts"),
		// 				Type: to.Ptr("Microsoft.Network/PerimeterAssociableResourceTypes"),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Storage.storageAccounts"),
		// 				Properties: &armnetwork.PerimeterAssociableResourceProperties{
		// 					DisplayName: to.Ptr("Microsoft.Storage/accounts"),
		// 					PublicDNSZones: []*string{
		// 						to.Ptr("blob.core.windows.net"),
		// 						to.Ptr("table.core.windows.net"),
		// 						to.Ptr("queue.core.windows.net"),
		// 						to.Ptr("file.core.windows.net")},
		// 						ResourceType: to.Ptr("Microsoft.Storage/accounts"),
		// 					},
		// 			}},
		// 		}
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter
 *
 * @summary Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/PerimeterAssociableResourcesList.json
 */
async function networkSecurityPerimeterAssociableResourceTypes() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const location = "westus";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.networkSecurityPerimeterAssociableResourceTypes.list(location)) {
    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.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/PerimeterAssociableResourcesList.json
// this example is just showing the usage of "NetworkSecurityPerimeterAssociableResourceTypes_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subId";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("westus");
await foreach (NetworkSecurityPerimeterAssociableResourceType item in subscriptionResource.GetNetworkSecurityPerimeterAssociableResourceTypesAsync(location))
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "name": "Microsoft.Sql.servers",
      "id": "/subscriptions/{subscriptionID}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Sql.servers",
      "type": "Microsoft.Network/PerimeterAssociableResourceTypes",
      "properties": {
        "resourceType": "Microsoft.Sql/servers",
        "displayName": "Microsoft.Sql/servers",
        "publicDnsZones": [
          "database.windows.net"
        ]
      }
    },
    {
      "name": "Microsoft.Storage.accounts",
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Storage.storageAccounts",
      "type": "Microsoft.Network/PerimeterAssociableResourceTypes",
      "properties": {
        "resourceType": "Microsoft.Storage/accounts",
        "displayName": "Microsoft.Storage/accounts",
        "publicDnsZones": [
          "blob.core.windows.net",
          "table.core.windows.net",
          "queue.core.windows.net",
          "file.core.windows.net"
        ]
      }
    }
  ],
  "nextLink": "{baseurl}/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes?api-version=2024-07-01&$skipToken=10"
}

Определения

Имя	Описание
CloudError	Ответ на ошибку службы.
CloudErrorBody	Ответ на ошибку службы.
PerimeterAssociableResource	Ресурс, подключенный для использования периметра безопасности сети. Также называется ресурсом периметра, ассоциируемым.
PerimeterAssociableResourcesListResult	Список страничных ресурсов периметра, которые можно связывать.

CloudError

Object

Ответ на ошибку службы.

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Object

Ответ на ошибку службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

PerimeterAssociableResource

Object

Ресурс, подключенный для использования периметра безопасности сети. Также называется ресурсом периметра, ассоциируемым.

Имя	Тип	Описание
id	string	Идентификатор ресурса периметра, связываемого с периметром.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.displayName	string	Понятное имя свойств связываемых ресурсов периметра.
properties.publicDnsZones	string[]	Имена общедоступных зон DNS ресурсов.
properties.resourceType	string	Имя типа ресурса или поставщика.
type	string	Тип ресурса.

PerimeterAssociableResourcesListResult

Object

Список страничных ресурсов периметра, которые можно связывать.

Имя	Тип	Описание
nextLink	string	Получает URL-адрес для получения следующей страницы результатов.
value	PerimeterAssociableResource[]	Возвращает список страничных ресурсов периметра, которые можно связывать.