Condividi tramite

Namespaces - Create Or Update

Servizio:
Event Hubs
Versione API:
2024-01-01

Crea o aggiorna uno spazio dei nomi. Dopo la creazione, il manifesto della risorsa dello spazio dei nomi non è modificabile. Questa operazione è idempotente.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
namespaceName
 path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

Nome spazio dei nomi
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId
 path True

string

Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version
 query True

string

Versione dell'API client.

Corpo della richiesta

Nome Tipo Descrizione
parameters

EHNamespace

Parametri per la creazione di una risorsa dello spazio dei nomi.

Risposte

Nome Tipo Descrizione
200 OK

EHNamespace

Spazio dei nomi creato correttamente.
201 Created

EHNamespace

Richiesta di creazione dello spazio dei nomi accettata.
202 Accepted

Richiesta di creazione o aggiornamento dello spazio dei nomi accettata.
Other Status Codes

ErrorResponse

Risposta di errore di EventHub che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

NamespaceCreate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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/"
  }
}
Codice di stato:
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/"
  }
}
Codice di stato:
202

Definizioni

Nome Descrizione
ConnectionState

Dettagli sullo stato della connessione.
createdByType

Tipo di identità che ha creato la risorsa.
EHNamespace

Singolo elemento dello spazio dei nomi nell'operazione Elenco o Get
EndPointProvisioningState

Stato di provisioning della connessione endpoint privato.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
keySource

Enumera il valore possibile di keySource per la crittografia
KeyVaultProperties

Proprietà di KeyVault
ManagedServiceIdentityType

Tipo di identità del servizio gestito.
PrivateEndpoint

Risorsa endpoint privato per questa connessione.
PrivateEndpointConnection

Elenco delle connessioni endpoint private.
PrivateLinkConnectionStatus

Stato della connessione.
PublicNetworkAccess

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata.
Sku

Proprietà della risorsa sku
SkuName

Nome di questo SKU.
SkuTier

Livello di fatturazione di questo SKU specifico.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
TlsVersion

Versione minima di TLS per il supporto del cluster, ad esempio '1.2'
UserAssignedIdentity

Valore del dizionario riconosciuto.

ConnectionState

Object

Dettagli sullo stato della connessione.

Nome Tipo Descrizione
description

string

Descrizione dello stato della connessione.
status

PrivateLinkConnectionStatus

Stato della connessione.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

EHNamespace

Object

Singolo elemento dello spazio dei nomi nell'operazione Elenco o Get

Nome Tipo Valore predefinito Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

ObjectId dall'insieme di credenziali delle chiavi
identity.tenantId

string

TenantId dall'insieme di credenziali delle chiavi
identity.type

ManagedServiceIdentityType

Tipo di identità del servizio gestito.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Proprietà per le identità assegnate dall'utente
location

string

Percorso della risorsa.
name

string

Nome della risorsa
properties.alternateName

string

Nome alternativo specificato quando i nomi alias e spazio dei nomi sono uguali.
properties.clusterArmId

string

ID ARM del cluster dello spazio dei nomi.
properties.createdAt

string (date-time)

Ora di creazione dello spazio dei nomi.
properties.disableLocalAuth

boolean

Questa proprietà disabilita l'autenticazione sas per lo spazio dei nomi di Hub eventi.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Enumera il valore possibile di keySource per la crittografia
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Proprietà di KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Abilitare la crittografia dell'infrastruttura (crittografia doppia)
properties.isAutoInflateEnabled

boolean

Valore che indica se AutoInflate è abilitato per lo spazio dei nomi eventhub.
properties.kafkaEnabled

boolean

Valore che indica se Kafka è abilitato per lo spazio dei nomi eventhub.
properties.maximumThroughputUnits

integer (int32)

minimum: 0

Limite massimo di unità elaborate quando l'aumento automatico è abilitato, il valore deve essere compreso tra 0 e 20 unità elaborate. ( '0' se AutoInflateEnabled = true)
properties.metricId

string

Identificatore per le metriche di Azure Insights.
properties.minimumTlsVersion

TlsVersion

Versione minima di TLS per il supporto del cluster, ad esempio '1.2'
properties.privateEndpointConnections

PrivateEndpointConnection[]

Elenco delle connessioni endpoint private.
properties.provisioningState

string

Stato di provisioning dello spazio dei nomi.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata.
properties.serviceBusEndpoint

string

Endpoint che è possibile usare per eseguire operazioni del bus di servizio.
properties.status

string

Stato dello spazio dei nomi.
properties.updatedAt

string (date-time)

Ora in cui lo spazio dei nomi è stato aggiornato.
properties.zoneRedundant

boolean

L'abilitazione di questa proprietà crea uno spazio dei nomi di Hub eventi standard nelle aree supportate dalle zone di disponibilità.
sku

Sku

Proprietà della risorsa sku
systemData

systemData

Metadati di sistema relativi a questa risorsa.
tags

object

Tag di risorsa.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Enumerazione

Stato di provisioning della connessione endpoint privato.

Valore Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

keySource

Enumerazione

Enumera il valore possibile di keySource per la crittografia

Valore Descrizione
Microsoft.KeyVault

KeyVaultProperties

Object

Proprietà di KeyVault

Nome Tipo Descrizione
identity.userAssignedIdentity

string

ID ARM dell'identità utente selezionata per la crittografia
keyName

string

Nome della chiave da KeyVault
keyVaultUri

string

Uri dell'insieme di credenziali delle chiavi
keyVersion

string

Versione chiave

ManagedServiceIdentityType

Enumerazione

Tipo di identità del servizio gestito.

Valore Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

Risorsa endpoint privato per questa connessione.

Nome Tipo Descrizione
id

string

Identificatore arm per endpoint privato.

PrivateEndpointConnection

Object

Elenco delle connessioni endpoint private.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Posizione geografica in cui risiede la risorsa
name

string

Nome della risorsa
properties.privateEndpoint

PrivateEndpoint

Risorsa endpoint privato per questa connessione.
properties.privateLinkServiceConnectionState

ConnectionState

Dettagli sullo stato della connessione.
properties.provisioningState

EndPointProvisioningState

Stato di provisioning della connessione endpoint privato.
systemData

systemData

Metadati di sistema relativi a questa risorsa.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumerazione

Stato della connessione.

Valore Descrizione
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumerazione

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata.

Valore Descrizione
Disabled
Enabled
SecuredByPerimeter

Sku

Object

Proprietà della risorsa sku

Nome Tipo Descrizione
capacity

integer (int32)

minimum: 0

Le unità elaborate di Hub eventi per i livelli Basic o Standard, dove il valore deve essere compreso tra 0 e 20 unità elaborate. Le unità Premium di Hub eventi per il livello Premium, dove il valore deve essere compreso tra 0 e 10 unità Premium.
name

SkuName

Nome di questo SKU.
tier

SkuTier

Livello di fatturazione di questo SKU specifico.

SkuName

Enumerazione

Nome di questo SKU.

Valore Descrizione
Basic
Premium
Standard

SkuTier

Enumerazione

Livello di fatturazione di questo SKU specifico.

Valore Descrizione
Basic
Premium
Standard

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

TlsVersion

Enumerazione

Versione minima di TLS per il supporto del cluster, ad esempio '1.2'

Valore Descrizione
1.0
1.1
1.2

UserAssignedIdentity

Object

Valore del dizionario riconosciuto.

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata dall'utente
principalId

string

ID entità dell'identità assegnata dall'utente