Namespaces - Create Or Update Network Rule Set

Serviço:: Event Hubs

Versão da API:: 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 minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	O nome do namespace
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 o 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 pelo perímetro de segurança de rede e pelas regras de acesso 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 do VirtualNetwork

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NameSpaceNetworkRuleSetCreate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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 o 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 filtro IP
NetworkRuleSet	Descrição do recurso de tópico.
NWRuleSetIpRules	A resposta da operação namespace Lista.
NWRuleSetVirtualNetworkRules	A resposta da operação namespace Lista.
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 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

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultAction

Enumeração

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

Valor	Description
Allow
Deny

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

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

Enumeração

A ação filtro IP

Valor	Description
Allow

NetworkRuleSet

Objeto

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 onde o recurso reside
name	string		O nome do recurso
properties.defaultAction	DefaultAction		Ação padrão para o 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 pelo perímetro de segurança de rede e pelas regras de acesso 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 do VirtualNetwork
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Objeto

A resposta da operação namespace Lista.

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

NWRuleSetVirtualNetworkRules

Objeto

A resposta da operação namespace Lista.

Nome	Tipo	Description
ignoreMissingVnetServiceEndpoint	boolean	Valor que indica se o ponto de extremidade de serviço de Vnet ausente deve ser ignorado
subnet	Subnet	Propriedades da sub-rede

PublicNetworkAccessFlag

Enumeração

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 pelo perímetro de segurança de rede e pelas regras de acesso do perfil.

Valor	Description
Enabled
Disabled
SecuredByPerimeter

Subnet

Objeto

Propriedades fornecidas para sub-rede

Nome	Tipo	Description
id	string	ID do recurso da sub-rede de rede virtual

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Namespaces - Create Or Update Network Rule Set

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

NameSpaceNetworkRuleSetCreate

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

DefaultAction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkRuleIPAction

NetworkRuleSet

NWRuleSetIpRules

NWRuleSetVirtualNetworkRules

PublicNetworkAccessFlag

Subnet

systemData