Udostępnij za pośrednictwem


Namespaces - Create Or Update

Tworzy lub aktualizuje przestrzeń nazw. Po utworzeniu manifest zasobu tej przestrzeni nazw jest niezmienny. Ta operacja jest idempotentna.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
namespaceName
path True

string

Nazwa przestrzeni nazw

Wzorzec wyrażenia regularnego: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Nazwa grupy zasobów w ramach subskrypcji platformy Azure.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa Typ Opis
parameters

EHNamespace

Parametry służące do tworzenia zasobu przestrzeni nazw.

Odpowiedzi

Nazwa Typ Opis
200 OK

EHNamespace

Przestrzeń nazw została pomyślnie utworzona.

201 Created

EHNamespace

Przestrzeń nazw tworzy zaakceptowane żądanie.

202 Accepted

Zaakceptowane żądanie utworzenia lub aktualizacji przestrzeni nazw.

Other Status Codes

ErrorResponse

Odpowiedź z błędem usługi EventHub opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

NamespaceCreate

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ConnectionState

Szczegółowe informacje o stanie połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

EHNamespace

Pojedynczy element przestrzeni nazw na liście lub operacji pobierania

EndPointProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

keySource

Wylicza możliwą wartość keySource dla szyfrowania

KeyVaultProperties

Właściwości usługi KeyVault

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

PrivateEndpoint

Zasób prywatnego punktu końcowego dla tego połączenia.

PrivateEndpointConnection

Lista połączeń prywatnych punktów końcowych.

PrivateLinkConnectionStatus

Stan połączenia.

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona.

Sku

Właściwości zasobu jednostki SKU

SkuName

Nazwa tej jednostki SKU.

SkuTier

Warstwa rozliczeniowa tej konkretnej jednostki SKU.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TlsVersion

Minimalna wersja protokołu TLS dla klastra do obsługi, np. "1.2"

UserAssignedIdentity

Wartość rozpoznanego słownika.

ConnectionState

Szczegółowe informacje o stanie połączenia.

Nazwa Typ Opis
description

string

Opis stanu połączenia.

status

PrivateLinkConnectionStatus

Stan połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Pojedynczy element przestrzeni nazw na liście lub operacji pobierania

Nazwa Typ Domyślna wartość Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity.principalId

string

ObjectId z usługi KeyVault

identity.tenantId

string

TenantId z usługi KeyVault

identity.type

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Właściwości tożsamości przypisanych przez użytkownika

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu

properties.alternateName

string

Nazwa alternatywna określona, gdy nazwy aliasów i przestrzeni nazw są takie same.

properties.clusterArmId

string

Identyfikator arm klastra przestrzeni nazw.

properties.createdAt

string

Czas utworzenia przestrzeni nazw.

properties.disableLocalAuth

boolean

Ta właściwość wyłącza uwierzytelnianie SYGNATURy dostępu współdzielonego dla przestrzeni nazw usługi Event Hubs.

properties.encryption.keySource

keySource

Microsoft.KeyVault

Wylicza możliwą wartość keySource dla szyfrowania

properties.encryption.keyVaultProperties

KeyVaultProperties[]

Właściwości usługi KeyVault

properties.encryption.requireInfrastructureEncryption

boolean

Włączanie szyfrowania infrastruktury (podwójne szyfrowanie)

properties.isAutoInflateEnabled

boolean

Wartość wskazująca, czy funkcja AutoInflate jest włączona dla przestrzeni nazw usługi EventHub.

properties.kafkaEnabled

boolean

Wartość wskazująca, czy platforma Kafka jest włączona dla przestrzeni nazw usługi EventHub.

properties.maximumThroughputUnits

integer

Górny limit jednostek przepływności po włączeniu funkcji AutoInflate wartość powinna mieścić się w zakresie od 0 do 20 jednostek przepływności. ( '0' if AutoInflateEnabled = true)

properties.metricId

string

Identyfikator metryk usługi Azure Insights.

properties.minimumTlsVersion

TlsVersion

Minimalna wersja protokołu TLS dla klastra do obsługi, np. "1.2"

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista połączeń prywatnych punktów końcowych.

properties.provisioningState

string

Stan aprowizacji przestrzeni nazw.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona.

properties.serviceBusEndpoint

string

Punkt końcowy, którego można użyć do wykonywania operacji usługi Service Bus.

properties.status

string

Stan przestrzeni nazw.

properties.updatedAt

string

Czas aktualizacji przestrzeni nazw.

properties.zoneRedundant

boolean

Włączenie tej właściwości powoduje utworzenie standardowej przestrzeni nazw usługi Event Hubs w regionach obsługiwanych przez strefy dostępności.

sku

Sku

Właściwości zasobu jednostki SKU

systemData

systemData

Metadane systemowe odnoszące się do tego zasobu.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

keySource

Wylicza możliwą wartość keySource dla szyfrowania

Nazwa Typ Opis
Microsoft.KeyVault

string

KeyVaultProperties

Właściwości usługi KeyVault

Nazwa Typ Opis
identity.userAssignedIdentity

string

Identyfikator arm tożsamości użytkownika wybranej do szyfrowania

keyName

string

Nazwa klucza z usługi KeyVault

keyVaultUri

string

Identyfikator URI usługi KeyVault

keyVersion

string

Wersja klucza

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

Zasób prywatnego punktu końcowego dla tego połączenia.

Nazwa Typ Opis
id

string

Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Lista połączeń prywatnych punktów końcowych.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.privateEndpoint

PrivateEndpoint

Zasób prywatnego punktu końcowego dla tego połączenia.

properties.privateLinkServiceConnectionState

ConnectionState

Szczegółowe informacje o stanie połączenia.

properties.provisioningState

EndPointProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

systemData

systemData

Metadane systemowe odnoszące się do tego zasobu.

type

string

Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Stan połączenia.

Nazwa Typ Opis
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona.

Nazwa Typ Opis
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Właściwości zasobu jednostki SKU

Nazwa Typ Opis
capacity

integer

Jednostki przepływności usługi Event Hubs dla warstw Podstawowa lub Standardowa, gdzie wartość powinna wynosić od 0 do 20 jednostek przepływności. Jednostki premium usługi Event Hubs dla warstwy Premium, gdzie wartość powinna wynosić od 0 do 10 jednostek premium.

name

SkuName

Nazwa tej jednostki SKU.

tier

SkuTier

Warstwa rozliczeniowa tej konkretnej jednostki SKU.

SkuName

Nazwa tej jednostki SKU.

Nazwa Typ Opis
Basic

string

Premium

string

Standard

string

SkuTier

Warstwa rozliczeniowa tej konkretnej jednostki SKU.

Nazwa Typ Opis
Basic

string

Premium

string

Standard

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Typ tożsamości, która ostatnio zmodyfikowała zasób.

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TlsVersion

Minimalna wersja protokołu TLS dla klastra do obsługi, np. "1.2"

Nazwa Typ Opis
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Wartość rozpoznanego słownika.

Nazwa Typ Opis
clientId

string

Identyfikator klienta tożsamości przypisanej przez użytkownika

principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika