Partager via

Namespaces - Create Or Update

  • Référence
Service:
Event Hubs
Version d'API:
2024-01-01

Crée ou met à jour un espace de noms. Une fois créé, le manifeste de ressource de cet espace de noms est immuable. Cette opération est idempotente.

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

Paramètres URI

Nom Dans Obligatoire Type Description
namespaceName
 path True

string

Nom de l’espace de noms

Modèle d’expression régulière: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Nom du groupe de ressources dans l’abonnement Azure.
subscriptionId
 path True

string

Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version
 query True

string

Version de l’API cliente.

Corps de la demande

Nom Type Description
parameters

EHNamespace

Paramètres de création d’une ressource d’espace de noms.

Réponses

Nom Type Description
200 OK

EHNamespace

Espace de noms créé avec succès.
201 Created

EHNamespace

Demande de création d’espace de noms acceptée.
202 Accepted

Demande de création ou de mise à jour d’espace de noms acceptée.
Other Status Codes

ErrorResponse

Réponse d’erreur Eventhub décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

NamespaceCreate

Exemple de requête

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

Exemple de réponse

Code d’état:
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/"
  }
}
Code d’état:
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/"
  }
}
Code d’état:
202

Définitions

Nom Description
ConnectionState

Détails sur l’état de la connexion.
createdByType

Type d’identité qui a créé la ressource.
EHNamespace

Élément d’espace de noms unique dans l’opération List ou Get
EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.
keySource

Énumère la valeur possible de keySource pour le chiffrement
KeyVaultProperties

Propriétés de KeyVault
ManagedServiceIdentityType

Type d’identité de service managé.
PrivateEndpoint

Ressource de point de terminaison privé pour cette connexion.
PrivateEndpointConnection

Liste des connexions de point de terminaison privé.
PrivateLinkConnectionStatus

État de la connexion.
PublicNetworkAccess

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé.
Sku

Propriétés de la ressource SKU
SkuName

Nom de cette référence SKU.
SkuTier

Niveau de facturation de cette référence SKU particulière.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
TlsVersion

Version TLS minimale à prendre en charge pour le cluster, par exemple « 1.2 »
UserAssignedIdentity

Valeur de dictionnaire reconnue.

ConnectionState

Détails sur l’état de la connexion.

Nom Type Description
description

string

Description de l’état de la connexion.
status

PrivateLinkConnectionStatus

État de la connexion.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Élément d’espace de noms unique dans l’opération List ou Get

Nom Type Valeur par défaut Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

ObjectId à partir de KeyVault
identity.tenantId

string

TenantId à partir du KeyVault
identity.type

ManagedServiceIdentityType

Type d’identité de service managé.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Propriétés des identités affectées par l’utilisateur
location

string

Emplacement de la ressource.
name

string

nom de la ressource.
properties.alternateName

string

Autre nom spécifié lorsque les noms d’alias et d’espace de noms sont identiques.
properties.clusterArmId

string

ID ARM de cluster de l’espace de noms.
properties.createdAt

string

Heure de création de l’espace de noms.
properties.disableLocalAuth

boolean

Cette propriété désactive l’authentification SAP pour l’espace de noms Event Hubs.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Énumère la valeur possible de keySource pour le chiffrement
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Propriétés de KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Activer le chiffrement d’infrastructure (double chiffrement)
properties.isAutoInflateEnabled

boolean

Valeur qui indique si AutoInflate est activé pour l’espace de noms eventhub.
properties.kafkaEnabled

boolean

Valeur qui indique si Kafka est activé pour l’espace de noms eventhub.
properties.maximumThroughputUnits

integer

Limite supérieure des unités de débit lorsque l’ininflate automatique est activée, la valeur doit être comprise entre 0 et 20 unités de débit. ( '0' si AutoInflateEnabled = true)
properties.metricId

string

Identificateur des métriques Azure Insights.
properties.minimumTlsVersion

TlsVersion

Version TLS minimale à prendre en charge pour le cluster, par exemple « 1.2 »
properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé.
properties.provisioningState

string

État d’approvisionnement de l’espace de noms.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé.
properties.serviceBusEndpoint

string

Point de terminaison que vous pouvez utiliser pour effectuer des opérations Service Bus.
properties.status

string

État de l’espace de noms.
properties.updatedAt

string

Heure à laquelle l’espace de noms a été mis à jour.
properties.zoneRedundant

boolean

L’activation de cette propriété crée un espace de noms Event Hubs Standard dans les zones de disponibilité prises en charge.
sku

Sku

Propriétés de la ressource SKU
systemData

systemData

Métadonnées système relatives à cette ressource.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.

Nom Type Description
error

ErrorDetail

Objet d’erreur.

keySource

Énumère la valeur possible de keySource pour le chiffrement

Nom Type Description
Microsoft.KeyVault

string

KeyVaultProperties

Propriétés de KeyVault

Nom Type Description
identity.userAssignedIdentity

string

ID ARM de l’identité utilisateur sélectionnée pour le chiffrement
keyName

string

Nom de la clé de KeyVault
keyVaultUri

string

URI de KeyVault
keyVersion

string

Version de la clé

ManagedServiceIdentityType

Type d’identité de service managé.

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

Ressource de point de terminaison privé pour cette connexion.

Nom Type Description
id

string

Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Liste des connexions de point de terminaison privé.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.privateEndpoint

PrivateEndpoint

Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState

ConnectionState

Détails sur l’état de la connexion.
properties.provisioningState

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.
systemData

systemData

Métadonnées système relatives à cette ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

PrivateLinkConnectionStatus

État de la connexion.

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé.

Nom Type Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Propriétés de la ressource SKU

Nom Type Description
capacity

integer

Unités de débit Event Hubs pour les niveaux De base ou Standard, où la valeur doit être comprise entre 0 et 20 unités de débit. Unités premium Event Hubs pour le niveau Premium, où la valeur doit être comprise entre 0 et 10 unités Premium.
name

SkuName

Nom de cette référence SKU.
tier

SkuTier

Niveau de facturation de cette référence SKU particulière.

SkuName

Nom de cette référence SKU.

Nom Type Description
Basic

string

Premium

string

Standard

string

SkuTier

Niveau de facturation de cette référence SKU particulière.

Nom Type Description
Basic

string

Premium

string

Standard

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Type d’identité qui a modifié la dernière ressource.
lastModifiedBy

string

Identité qui a modifié la dernière ressource.
lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

TlsVersion

Version TLS minimale à prendre en charge pour le cluster, par exemple « 1.2 »

Nom Type Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Valeur de dictionnaire reconnue.

Nom Type Description
clientId

string

ID client de l’identité affectée par l’utilisateur
principalId

string

ID principal de l’identité affectée par l’utilisateur