Network Rule Sets - List Network Rule Set

Ссылка

Service:: Event Hubs

API Version:: 2021-11-01

Возвращает NetworkRuleSet для пространства имен.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets?api-version=2021-11-01

Параметры URI

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

Ответы

Name	Type	Description
200 OK	NetworkRuleSetListResult	NetworkRuleSet успешно возвращен.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

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

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

NameSpaceNetworkRuleSetList

Sample Request

GET https://management.azure.com/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/networkRuleSets?api-version=2021-11-01

import com.azure.core.util.Context;

/** Samples for Namespaces ListNetworkRuleSet. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json
     */
    /**
     * Sample code: NameSpaceNetworkRuleSetList.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceNetworkRuleSetList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .eventHubs()
            .manager()
            .serviceClient()
            .getNamespaces()
            .listNetworkRuleSetWithResponse("ResourceGroup", "sdk-Namespace-6019", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json
func ExampleNamespacesClient_ListNetworkRuleSet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventhub.NewNamespacesClient("Subscription", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListNetworkRuleSet(ctx,
		"ResourceGroup",
		"sdk-Namespace-6019",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

/**
 * This sample demonstrates how to Gets NetworkRuleSet for a Namespace.
 *
 * @summary Gets NetworkRuleSet for a Namespace.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json
 */
async function nameSpaceNetworkRuleSetList() {
  const subscriptionId = "Subscription";
  const resourceGroupName = "ResourceGroup";
  const namespaceName = "sdk-Namespace-6019";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const result = await client.namespaces.listNetworkRuleSet(resourceGroupName, namespaceName);
  console.log(result);
}

nameSpaceNetworkRuleSetList().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default",
      "name": "default",
      "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet",
      "properties": {
        "defaultAction": "Deny",
        "virtualNetworkRules": [
          {
            "subnet": {
              "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
            },
            "ignoreMissingVnetServiceEndpoint": true
          },
          {
            "subnet": {
              "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
            },
            "ignoreMissingVnetServiceEndpoint": false
          },
          {
            "subnet": {
              "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"
            },
            "ignoreMissingVnetServiceEndpoint": false
          }
        ],
        "ipRules": [
          {
            "ipMask": "1.1.1.1",
            "action": "Allow"
          },
          {
            "ipMask": "1.1.1.2",
            "action": "Allow"
          },
          {
            "ipMask": "1.1.1.3",
            "action": "Allow"
          },
          {
            "ipMask": "1.1.1.4",
            "action": "Allow"
          },
          {
            "ipMask": "1.1.1.5",
            "action": "Allow"
          }
        ]
      }
    }
  ]
}

Определения

createdByType	Тип удостоверения, создавшего ресурс.
DefaultAction	Действие по умолчанию для набора правил сети
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.
NetworkRuleIPAction	Действие фильтра IP-адресов
NetworkRuleSet	Описание ресурса раздела.
NetworkRuleSetListResult	Ответ операции List NetworkRuleSet
NWRuleSetIpRules	Ответ операции пространства имен списка.
NWRuleSetVirtualNetworkRules	Ответ операции пространства имен списка.
PublicNetworkAccessFlag	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
Subnet	Свойства, предоставляемые для подсети
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Действие по умолчанию для набора правил сети

Name	Type	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name	Type	Description
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Name	Type	Description
error	ErrorDetail	Объект ошибки.

NetworkRuleIPAction

Действие фильтра IP-адресов

Name	Type	Description
Allow	string

NetworkRuleSet

Описание ресурса раздела.

Name	Type	Default Value	Description
id	string		Полный идентификатор ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Географическое расположение, в котором находится ресурс.
name	string		Имя ресурса.
properties.defaultAction	DefaultAction		Действие по умолчанию для набора правил сети
properties.ipRules	NWRuleSetIpRules[]		Список IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
properties.trustedServiceAccessEnabled	boolean		Значение, указывающее, включен ли доступ к доверенной службе.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Перечисление правил VirtualNetwork
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
type	string		Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

NetworkRuleSetListResult

Ответ операции List NetworkRuleSet

Name	Type	Description
nextLink	string	Ссылка на следующий набор результатов. Не пуст, если значение содержит неполный список NetworkRuleSet.
value	NetworkRuleSet[]	Результат операции List NetworkRuleSet

NWRuleSetIpRules

Ответ операции пространства имен списка.

Name	Type	Description
action	NetworkRuleIPAction	Действие фильтра IP-адресов
ipMask	string	Маска IP

NWRuleSetVirtualNetworkRules

Ответ операции пространства имен списка.

Name	Type	Description
ignoreMissingVnetServiceEndpoint	boolean	Значение, указывающее, следует ли игнорировать отсутствующую конечную точку службы виртуальной сети.
subnet	Subnet	Свойства подсети

PublicNetworkAccessFlag

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.

Name	Type	Description
Disabled	string
Enabled	string

Subnet

Свойства, предоставляемые для подсети

Name	Type	Description
id	string	Идентификатор ресурса подсети виртуальная сеть

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Name	Type	Description
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Тип удостоверения, который последний раз изменил ресурс.
lastModifiedBy	string	Удостоверение, которое в последний раз изменило ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.