Namespaces - Create Or Update Network Rule Set

Referens

Service:: Event Hubs

API Version:: 2024-01-01

Skapa eller uppdatera NetworkRuleSet för ett namnområde.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
namespaceName	path	True	string	Namnområdesnamnet Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Namnet på resursgruppen i Azure-prenumerationen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
properties.defaultAction	DefaultAction	Standardåtgärd för nätverksregeluppsättning
properties.ipRules	NWRuleSetIpRules[]	Lista över IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Om värdet är SecuredByPerimeter styrs inkommande och utgående kommunikation av nätverkssäkerhetsperimetern och profilens åtkomstregler.
properties.trustedServiceAccessEnabled	boolean	Värde som anger om betrodd tjänståtkomst är aktiverad eller inte.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Lista VirtualNetwork-regler

Svar

Name	Typ	Description
200 OK	NetworkRuleSet	Namespace NetworkRuleSet returnerades.
Other Status Codes	ErrorResponse	ServiceBus-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
DefaultAction	Standardåtgärd för nätverksregeluppsättning
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
NetworkRuleIPAction	IP-filteråtgärden
NetworkRuleSet	Beskrivning av ämnesresurs.
NWRuleSetIpRules	Svaret från listnamnområdesåtgärden.
NWRuleSetVirtualNetworkRules	Svaret från listnamnområdesåtgärden.
PublicNetworkAccessFlag	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Om värdet är SecuredByPerimeter styrs inkommande och utgående kommunikation av nätverkssäkerhetsperimetern och profilens åtkomstregler.
Subnet	Egenskaper som anges för undernät
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Standardåtgärd för nätverksregeluppsättning

Name	Typ	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
error	ErrorDetail	Felobjektet.

NetworkRuleIPAction

IP-filteråtgärden

Name	Typ	Description
Allow	string

NetworkRuleSet

Beskrivning av ämnesresurs.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Den geo-plats där resursen finns
name	string		Namnet på resursen
properties.defaultAction	DefaultAction		Standardåtgärd för nätverksregeluppsättning
properties.ipRules	NWRuleSetIpRules[]		Lista över IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Om värdet är SecuredByPerimeter styrs inkommande och utgående kommunikation av nätverkssäkerhetsperimetern och profilens åtkomstregler.
properties.trustedServiceAccessEnabled	boolean		Värde som anger om betrodd tjänståtkomst är aktiverad eller inte.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Lista VirtualNetwork-regler
systemData	systemData		Systemmetadata som relaterar till den här resursen.
type	string		Resurstypen. Till exempel "Microsoft.EventHub/Namespaces" eller "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Svaret från listnamnområdesåtgärden.

Name	Typ	Description
action	NetworkRuleIPAction	IP-filteråtgärden
ipMask	string	IP-mask

NWRuleSetVirtualNetworkRules