Namespaces - Create Or Update Network Rule Set

Referência

Service:: Event Hubs

API Version:: 2024-01-01

Crie ou atualize NetworkRuleSet para um Namespace.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	O nome do namespace Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome do grupo de recursos na assinatura do azure.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.defaultAction	DefaultAction	Ação padrão para conjunto de regras de rede
properties.ipRules	NWRuleSetIpRules[]	Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Se o valor for SecuredByPerimeter, a comunicação de entrada e saída será controlada pelas regras de acesso do perímetro de segurança de rede e do perfil.
properties.trustedServiceAccessEnabled	boolean	Valor que indica se o Acesso ao Serviço Confiável está Habilitado ou não.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Listar Regras de Rede Virtual

Respostas

Nome	Tipo	Description
200 OK	NetworkRuleSet	Namespace NetworkRuleSet retornado com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NameSpaceNetworkRuleSetCreate

Sample Request

HTTP

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

{
  "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"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/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"
      }
    ]
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
DefaultAction	Ação padrão para conjunto de regras de rede
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
NetworkRuleIPAction	A ação de filtro IP
NetworkRuleSet	Descrição do recurso de tópico.
NWRuleSetIpRules	A resposta da operação de namespace Listar.
NWRuleSetVirtualNetworkRules	A resposta da operação de namespace Listar.
PublicNetworkAccessFlag	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Se o valor for SecuredByPerimeter, a comunicação de entrada e saída será controlada pelas regras de acesso do perímetro de segurança de rede e do perfil.
Subnet	Propriedades fornecidas para Sub-rede
systemData	Metadados relativos à criação e à última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Ação padrão para conjunto de regras de rede

Nome	Tipo	Description
Allow	string
Deny	string

ErrorAdditionalInfo

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

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

ErrorDetail

O detalhe do erro.

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

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

NetworkRuleIPAction

A ação de filtro IP

Nome	Tipo	Description
Allow	string

NetworkRuleSet

Descrição do recurso de tópico.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		A localização geográfica em que o recurso reside
name	string		O nome do recurso
properties.defaultAction	DefaultAction		Ação padrão para conjunto de regras de rede
properties.ipRules	NWRuleSetIpRules[]		Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Se o valor for SecuredByPerimeter, a comunicação de entrada e saída será controlada pelas regras de acesso do perímetro de segurança de rede e do perfil.
properties.trustedServiceAccessEnabled	boolean		Valor que indica se o Acesso ao Serviço Confiável está Habilitado ou não.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Listar Regras de Rede Virtual
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
type	string		Tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

A resposta da operação de namespace Listar.

Nome	Tipo	Description
action	NetworkRuleIPAction	A ação de filtro IP
ipMask	string	Máscara de IP

NWRuleSetVirtualNetworkRules