Sdílet prostřednictvím

Namespaces - Create Or Update

  • Reference
Služba:
Event Hubs
Verze rozhraní API:
2024-01-01

Vytvoří nebo aktualizuje obor názvů. Po vytvoření je manifest prostředku tohoto oboru názvů neměnný. Tato operace je idempotentní.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
namespaceName
 path True

string

Název oboru názvů

Vzor regulárního výrazu: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Název skupiny prostředků v rámci předplatného Azure
subscriptionId
 path True

string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version
 query True

string

Verze klientského rozhraní API.

Text požadavku

Name Typ Description
parameters

EHNamespace

Parametry pro vytvoření prostředku oboru názvů

Odpovědi

Name Typ Description
200 OK

EHNamespace

Obor názvů se úspěšně vytvořil.
201 Created

EHNamespace

Žádost o vytvoření oboru názvů byla přijata.
202 Accepted

Žádost o vytvoření nebo aktualizaci oboru názvů byla přijata.
Other Status Codes

ErrorResponse

Odpověď na chybu Centra událostí popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

NamespaceCreate

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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/"
  }
}
Stavový kód:
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/"
  }
}
Stavový kód:
202

Definice

Name Description
ConnectionState

Podrobnosti o stavu připojení.
createdByType

Typ identity, která prostředek vytvořila.
EHNamespace

Položka s jedním oborem názvů v seznamu nebo operaci get
EndPointProvisioningState

Stav zřizování připojení privátního koncového bodu.
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě
ErrorResponse

Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
keySource

Vytvoří výčet možné hodnoty keySource pro šifrování.
KeyVaultProperties

Vlastnosti služby KeyVault
ManagedServiceIdentityType

Typ identity spravované služby
PrivateEndpoint

Prostředek privátního koncového bodu pro toto připojení.
PrivateEndpointConnection

Seznam připojení privátních koncových bodů
PrivateLinkConnectionStatus

Stav připojení.
PublicNetworkAccess

Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená.
Sku

Vlastnosti prostředku skladové položky
SkuName

Název této skladové položky
SkuTier

Fakturační úroveň této konkrétní skladové položky
systemData

Metadata týkající se vytvoření a poslední změny prostředku.
TlsVersion

Minimální verze protokolu TLS, která má cluster podporovat, například 1.2
UserAssignedIdentity

Rozpoznaná hodnota slovníku

ConnectionState

Podrobnosti o stavu připojení.

Name Typ Description
description

string

Popis stavu připojení
status

PrivateLinkConnectionStatus

Stav připojení.

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Položka s jedním oborem názvů v seznamu nebo operaci get

Name Typ Default value Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
identity.principalId

string

ObjectId ze služby Key Vault
identity.tenantId

string

Id tenanta ze služby Key Vault
identity.type

ManagedServiceIdentityType

Typ identity spravované služby
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Vlastnosti identit přiřazených uživatelem
location

string

Umístění prostředku.
name

string

Název prostředku
properties.alternateName

string

Alternativní název zadaný v případech, kdy jsou názvy aliasu a oboru názvů stejné.
properties.clusterArmId

string

ID ARM clusteru oboru názvů.
properties.createdAt

string

Čas vytvoření oboru názvů.
properties.disableLocalAuth

boolean

Tato vlastnost zakáže ověřování SAS pro obor názvů služby Event Hubs.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Vytvoří výčet možné hodnoty keySource pro šifrování.
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Vlastnosti služby KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Povolit šifrování infrastruktury (dvojité šifrování)
properties.isAutoInflateEnabled

boolean

Hodnota, která označuje, jestli je pro obor názvů eventhubu povolené automatické rozšiřování.
properties.kafkaEnabled

boolean

Hodnota, která označuje, jestli má kafka povolený obor názvů centra událostí.
properties.maximumThroughputUnits

integer

Horní limit jednotek propustnosti, pokud je povolené automatické rozšiřování, hodnota by měla být v rozmezí od 0 do 20 jednotek propustnosti. ( '0', pokud AutoInflateEnabled = true)
properties.metricId

string

Identifikátor metrik Azure Insights
properties.minimumTlsVersion

TlsVersion

Minimální verze protokolu TLS, která má cluster podporovat, například 1.2
properties.privateEndpointConnections

PrivateEndpointConnection[]

Seznam připojení privátních koncových bodů
properties.provisioningState

string

Stav zřizování oboru názvů.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená.
properties.serviceBusEndpoint

string

Koncový bod, který můžete použít k provádění operací služby Service Bus.
properties.status

string

Stav oboru názvů.
properties.updatedAt

string

Čas aktualizace oboru názvů.
properties.zoneRedundant

boolean

Povolením této vlastnosti vytvoříte obor názvů služby Event Hubs úrovně Standard v podporovaných oblastech dostupnosti.
sku

Sku

Vlastnosti prostředku skladové položky
systemData

systemData

Metadata systému vztahující se k tomuto prostředku.
tags

object

Značky prostředků.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

EndPointProvisioningState

Stav zřizování připojení privátního koncového bodu.

Name Typ Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva
target

string

Cíl chyby.

ErrorResponse

Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Name Typ Description
error

ErrorDetail

Objekt chyby.

keySource

Vytvoří výčet možné hodnoty keySource pro šifrování.

Name Typ Description
Microsoft.KeyVault

string

KeyVaultProperties

Vlastnosti služby KeyVault

Name Typ Description
identity.userAssignedIdentity

string

ID ARM identity uživatele vybrané pro šifrování
keyName

string

Název klíče ze služby Key Vault
keyVaultUri

string

Identifikátor URI služby KeyVault
keyVersion

string

Verze klíče

ManagedServiceIdentityType

Typ identity spravované služby

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

Prostředek privátního koncového bodu pro toto připojení.

Name Typ Description
id

string

Identifikátor ARM pro privátní koncový bod.

PrivateEndpointConnection

Seznam připojení privátních koncových bodů

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location

string

Geografické umístění, kde se prostředek nachází
name

string

Název prostředku
properties.privateEndpoint

PrivateEndpoint

Prostředek privátního koncového bodu pro toto připojení.
properties.privateLinkServiceConnectionState

ConnectionState

Podrobnosti o stavu připojení.
properties.provisioningState

EndPointProvisioningState

Stav zřizování připojení privátního koncového bodu.
systemData

systemData

Metadata systému vztahující se k tomuto prostředku.
type

string

Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

PrivateLinkConnectionStatus

Stav připojení.

Name Typ Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená.

Name Typ Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Vlastnosti prostředku skladové položky

Name Typ Description
capacity

integer

Jednotky propustnosti služby Event Hubs pro úrovně Basic nebo Standard, kde hodnota by měla být 0 až 20 jednotek propustnosti. Jednotky Premium služby Event Hubs pro úroveň Premium, kde hodnota by měla být 0 až 10 jednotek Premium.
name

SkuName

Název této skladové položky
tier

SkuTier

Fakturační úroveň této konkrétní skladové položky

SkuName

Název této skladové položky

Name Typ Description
Basic

string

Premium

string

Standard

string

SkuTier

Fakturační úroveň této konkrétní skladové položky

Name Typ Description
Basic

string

Premium

string

Standard

string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)
createdBy

string

Identita, která vytvořila prostředek.
createdByType

createdByType

Typ identity, která prostředek vytvořila.
lastModifiedAt

string

Typ identity, která naposledy změnila prostředek.
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

TlsVersion

Minimální verze protokolu TLS, která má cluster podporovat, například 1.2

Name Typ Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Rozpoznaná hodnota slovníku

Name Typ Description
clientId

string

ID klienta identity přiřazené uživatelem
principalId

string

ID objektu zabezpečení identity přiřazené uživatelem