Namespaces - Create Or Update Network Rule Set

Referência

Service:: Event Hubs

API Version:: 2024-01-01

Criar ou atualizar NetworkRuleSet para um Espaço de Nomes.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
namespaceName	path	True	string	O nome do Espaço de Nomes 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 subscrição do azure.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
properties.defaultAction	DefaultAction	Ação Predefinida para Conjunto de Regras de Rede
properties.ipRules	NWRuleSetIpRules[]	Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Se o valor for SecuredByPerimeter, a comunicação de Entrada e Saída é controlada pelo perímetro de segurança de rede e pelas regras de acesso do perfil.
properties.trustedServiceAccessEnabled	boolean	Valor que indica se o Acesso de Serviço Fidedigno está Ativado ou não.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Listar Regras de VirtualNetwork

Respostas

Name	Tipo	Description
200 OK	NetworkRuleSet	O Espaço de Nomes NetworkRuleSet foi devolvido com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

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

Name	Description
createdByType	O tipo de identidade que criou o recurso.
DefaultAction	Ação Predefinida para Conjunto de Regras de Rede
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.
NetworkRuleIPAction	A ação filtro ip
NetworkRuleSet	Descrição do recurso do tópico.
NWRuleSetIpRules	A resposta da operação Espaço de nomes de lista.
NWRuleSetVirtualNetworkRules	A resposta da operação Espaço de nomes de lista.
PublicNetworkAccessFlag	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Se o valor for SecuredByPerimeter, a comunicação de Entrada e Saída é controlada pelo perímetro de segurança de rede e pelas regras de acesso 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.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Ação Predefinida para Conjunto de Regras de Rede

Name	Tipo	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	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 a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

NetworkRuleIPAction

A ação filtro ip

Name	Tipo	Description
Allow	string

NetworkRuleSet

Descrição do recurso do tópico.

Name	Tipo	Valor Predefinido	Description
id	string		ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		A localização geográfica onde o recurso se encontra
name	string		O nome do recurso
properties.defaultAction	DefaultAction		Ação Predefinida para Conjunto de Regras de Rede
properties.ipRules	NWRuleSetIpRules[]		Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Se o valor for SecuredByPerimeter, a comunicação de Entrada e Saída é controlada pelo perímetro de segurança de rede e pelas regras de acesso do perfil.
properties.trustedServiceAccessEnabled	boolean		Valor que indica se o Acesso de Serviço Fidedigno está Ativado ou não.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Listar Regras de VirtualNetwork
systemData	systemData		Os metadados do sistema relacionados com este recurso.
type	string		O tipo de recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

A resposta da operação Espaço de nomes de lista.

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

NWRuleSetVirtualNetworkRules