Share via

Namespaces - Create Or Update

  • Referentie
Service:
Event Hubs
API Version:
2024-01-01

Hiermee wordt een naamruimte gemaakt of bijgewerkt. Na het maken is het resourcemanifest van deze naamruimte onveranderbaar. Deze bewerking is idempotent.

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

URI-parameters

Name In Vereist Type Description
namespaceName
 path True

string

De naam van de naamruimte

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

string

Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId
 path True

string

Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version
 query True

string

Client-API-versie.

Aanvraagbody

Name Type Description
parameters

EHNamespace

Parameters voor het maken van een naamruimteresource.

Antwoorden

Name Type Description
200 OK

EHNamespace

De naamruimte is gemaakt.
201 Created

EHNamespace

Aanvraag voor het maken van de naamruimte is geaccepteerd.
202 Accepted

Aanvraag voor maken of bijwerken van naamruimte geaccepteerd.
Other Status Codes

ErrorResponse

Eventhub-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

NamespaceCreate

Sample Request

PUT https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01

{
  "location": "East US",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {},
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {}
    }
  },
  "properties": {
    "encryption": {
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://aprao-keyvault-user.vault-int.azure-int.net/",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "keySource": "Microsoft.KeyVault"
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test"
  }
}

Sample Response

Status code:
200 
{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
  "name": "NamespaceSample",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "East US",
  "tags": {},
  "identity": {
    "principalId": "PrincipalIdGUID",
    "tenantId": "TenantIdGUID",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
        "clientId": "ClientIdGUID",
        "principalId": "PrincipalIdGUID"
      },
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
        "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
        "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
      }
    }
  },
  "properties": {
    "zoneRedundant": false,
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "minimumTlsVersion": "1.2",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
          "keyVersion": "",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "requireInfrastructureEncryption": false
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "kafkaEnabled": false,
    "provisioningState": "Succeeded",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-02-16T22:36:06.107Z",
    "updatedAt": "2021-02-16T22:37:42.29Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
  }
}
Status code:
201 
{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
  "name": "NamespaceSample",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "East US",
  "tags": {},
  "identity": {
    "principalId": "PrincipalIdGUID",
    "tenantId": "TenantIdGUID",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
        "clientId": "ClientIdGUID",
        "principalId": "PrincipalIdGUID"
      },
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
        "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
        "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
      }
    }
  },
  "properties": {
    "zoneRedundant": false,
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
          "keyVersion": "",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "requireInfrastructureEncryption": false
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "kafkaEnabled": false,
    "provisioningState": "Succeeded",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-02-16T22:36:06.107Z",
    "updatedAt": "2021-02-16T22:37:42.29Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
  }
}
Status code:
202

Definities

Name Description
ConnectionState

Details over de status van de verbinding.
createdByType

Het type identiteit waarmee de resource is gemaakt.
EHNamespace

Eén naamruimteitem in lijst of bewerking ophalen
EndPointProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
keySource

Inventariseert de mogelijke waarde van keySource voor versleuteling
KeyVaultProperties

Eigenschappen van KeyVault
ManagedServiceIdentityType

Type beheerde service-identiteit.
PrivateEndpoint

De privé-eindpuntresource voor deze verbinding.
PrivateEndpointConnection

Lijst met privé-eindpuntverbindingen.
PrivateLinkConnectionStatus

Status van de verbinding.
PublicNetworkAccess

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld.
Sku

Eigenschappen van SKU-resource
SkuName

Naam van deze SKU.
SkuTier

De factureringslaag van deze specifieke SKU.
systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TlsVersion

De minimale TLS-versie voor het cluster die moet worden ondersteund, bijvoorbeeld '1.2'
UserAssignedIdentity

Herkende woordenlijstwaarde.

ConnectionState

Details over de status van de verbinding.

Name Type Description
description

string

Beschrijving van de verbindingsstatus.
status

PrivateLinkConnectionStatus

Status van de verbinding.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Eén naamruimteitem in lijst of bewerking ophalen

Name Type Standaardwaarde Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

ObjectId van keyvault
identity.tenantId

string

TenantId van KeyVault
identity.type

ManagedServiceIdentityType

Type beheerde service-identiteit.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Eigenschappen voor door de gebruiker toegewezen identiteiten
location

string

Resourcelocatie.
name

string

De naam van de resource
properties.alternateName

string

Alternatieve naam opgegeven wanneer alias- en naamruimtenamen hetzelfde zijn.
properties.clusterArmId

string

Arm-cluster-id van de naamruimte.
properties.createdAt

string

Het tijdstip waarop de naamruimte is gemaakt.
properties.disableLocalAuth

boolean

Met deze eigenschap wordt SAS-verificatie uitgeschakeld voor de Event Hubs-naamruimte.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Inventariseert de mogelijke waarde van keySource voor versleuteling
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Eigenschappen van KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Infrastructuurversleuteling inschakelen (dubbele versleuteling)
properties.isAutoInflateEnabled

boolean

Waarde die aangeeft of AutoInflate is ingeschakeld voor eventhub-naamruimte.
properties.kafkaEnabled

boolean

Waarde die aangeeft of Kafka is ingeschakeld voor eventhub-naamruimte.
properties.maximumThroughputUnits

integer

Bovengrens van doorvoereenheden wanneer Automatisch vergroten is ingeschakeld, moet de waarde binnen 0 tot 20 doorvoereenheden zijn. ( '0' als AutoInflateEnabled = true)
properties.metricId

string

Id voor metrische gegevens van Azure Insights.
properties.minimumTlsVersion

TlsVersion

De minimale TLS-versie voor het cluster die moet worden ondersteund, bijvoorbeeld '1.2'
properties.privateEndpointConnections

PrivateEndpointConnection[]

Lijst met privé-eindpuntverbindingen.
properties.provisioningState

string

Inrichtingsstatus van de naamruimte.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld.
properties.serviceBusEndpoint

string

Eindpunt dat u kunt gebruiken om Service Bus-bewerkingen uit te voeren.
properties.status

string

Status van de naamruimte.
properties.updatedAt

string

Het tijdstip waarop de naamruimte is bijgewerkt.
properties.zoneRedundant

boolean

Als u deze eigenschap inschakelt, maakt u een Standard Event Hubs-naamruimte in ondersteunde beschikbaarheidszones.
sku

Sku

Eigenschappen van SKU-resource
systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.
tags

object

Resourcetags.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

EndPointProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Name Type Description
error

ErrorDetail

Het foutobject.

keySource

Inventariseert de mogelijke waarde van keySource voor versleuteling

Name Type Description
Microsoft.KeyVault

string

KeyVaultProperties

Eigenschappen van KeyVault

Name Type Description
identity.userAssignedIdentity

string

ARM-id van gebruikersidentiteit geselecteerd voor versleuteling
keyName

string

Naam van de sleutel van KeyVault
keyVaultUri

string

URI van KeyVault
keyVersion

string

Sleutelversie

ManagedServiceIdentityType

Type beheerde service-identiteit.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

De privé-eindpuntresource voor deze verbinding.

Name Type Description
id

string

De ARM-id voor het privé-eindpunt.

PrivateEndpointConnection

Lijst met privé-eindpuntverbindingen.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

De geografische locatie waar de resource zich bevindt
name

string

De naam van de resource
properties.privateEndpoint

PrivateEndpoint

De privé-eindpuntresource voor deze verbinding.
properties.privateLinkServiceConnectionState

ConnectionState

Details over de status van de verbinding.
properties.provisioningState

EndPointProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.
systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

PrivateLinkConnectionStatus

Status van de verbinding.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld.

Name Type Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Eigenschappen van SKU-resource

Name Type Description
capacity

integer

De Event Hubs-doorvoereenheden voor de Basic- of Standard-laag, waarbij de waarde 0 tot 20 doorvoereenheden moet zijn. De Premium-eenheden van Event Hubs voor de Premium-laag, waarbij de waarde 0 tot 10 Premium-eenheden moet zijn.
name

SkuName

Naam van deze SKU.
tier

SkuTier

De factureringslaag van deze specifieke SKU.

SkuName

Naam van deze SKU.

Name Type Description
Basic

string

Premium

string

Standard

string

SkuTier

De factureringslaag van deze specifieke SKU.

Name Type Description
Basic

string

Premium

string

Standard

string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string

Het type identiteit dat de resource het laatst heeft gewijzigd.
lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

TlsVersion

De minimale TLS-versie voor het cluster die moet worden ondersteund, bijvoorbeeld '1.2'

Name Type Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Herkende woordenlijstwaarde.

Name Type Description
clientId

string

Client-id van door de gebruiker toegewezen identiteit
principalId

string

Principal-id van door de gebruiker toegewezen identiteit