Compartir a través de

Namespaces - Create Or Update Network Rule Set

  • Referencia
Servicio:
Event Hubs
Versión de la API:
2024-01-01

Cree o actualice NetworkRuleSet para un espacio de nombres.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
namespaceName
 path True

string

El nombre del espacio de nombres

Patrón de Regex: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId
 path True

string

Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version
 query True

string

Versión de la API de cliente.

Cuerpo de la solicitud

Nombre Tipo Description
properties.defaultAction

DefaultAction

Acción predeterminada para el conjunto de reglas de red
properties.ipRules

NWRuleSetIpRules[]

Lista de IpRules
properties.publicNetworkAccess

PublicNetworkAccessFlag

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil.
properties.trustedServiceAccessEnabled

boolean

Valor que indica si el acceso al servicio de confianza está habilitado o no.
properties.virtualNetworkRules

NWRuleSetVirtualNetworkRules[]

Enumerar reglas de red virtual

Respuestas

Nombre Tipo Description
200 OK

NetworkRuleSet

Espacio de nombres NetworkRuleSet devuelto correctamente.
Other Status Codes

ErrorResponse

Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

NameSpaceNetworkRuleSetCreate

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.
DefaultAction

Acción predeterminada para el conjunto de reglas de red
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
NetworkRuleIPAction

Acción de filtro IP
NetworkRuleSet

Descripción del recurso de tema.
NWRuleSetIpRules

Respuesta de la operación List namespace .
NWRuleSetVirtualNetworkRules

Respuesta de la operación List namespace .
PublicNetworkAccessFlag

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil.
Subnet

Propiedades proporcionadas para subred
systemData

Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Acción predeterminada para el conjunto de reglas de red

Nombre Tipo Description
Allow

string

Deny

string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Los detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

NetworkRuleIPAction

Acción de filtro IP

Nombre Tipo Description
Allow

string

NetworkRuleSet

Descripción del recurso de tema.

Nombre Tipo Valor predeterminado Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Ubicación geográfica donde reside el recurso
name

string

Nombre del recurso.
properties.defaultAction

DefaultAction

Acción predeterminada para el conjunto de reglas de red
properties.ipRules

NWRuleSetIpRules[]

Lista de IpRules
properties.publicNetworkAccess

PublicNetworkAccessFlag

Enabled

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil.
properties.trustedServiceAccessEnabled

boolean

Valor que indica si el acceso al servicio de confianza está habilitado o no.
properties.virtualNetworkRules

NWRuleSetVirtualNetworkRules[]

Enumerar reglas de red virtual
systemData

systemData

Metadatos del sistema relacionados con este recurso.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Respuesta de la operación List namespace .

Nombre Tipo Description
action

NetworkRuleIPAction

Acción de filtro IP
ipMask

string

Máscara ip

NWRuleSetVirtualNetworkRules

Respuesta de la operación List namespace .

Nombre Tipo Description
ignoreMissingVnetServiceEndpoint

boolean

Valor que indica si se omitirá el punto de conexión de servicio de red virtual que falta.
subnet

Subnet

Propiedades de subred

PublicNetworkAccessFlag

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Si el valor es SecuredByPerimeter, la comunicación entrante y saliente se controla mediante las reglas de acceso del perímetro de seguridad de red y del perfil.

Nombre Tipo Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Subnet

Propiedades proporcionadas para subred

Nombre Tipo Description
id

string

Identificador de recurso de Virtual Network subred

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.