Partilhar via

Namespaces - Create Or Update

  • Referência
Serviço:
Event Hubs
Versão da API:
2024-01-01

Cria ou atualiza um espaço de nomes. Depois de criado, o manifesto de recursos deste espaço de nomes é imutável. Esta operação é idempotente.

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

Parâmetros do URI

Name Em Necessário Tipo Description
namespaceName
 path True

string

O nome do Espaço de Nomes

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

string

Nome do grupo de recursos na subscrição do azure.
subscriptionId
 path True

string

Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version
 query True

string

Versão da API de Cliente.

Corpo do Pedido

Name Tipo Description
parameters

EHNamespace

Parâmetros para criar um recurso de espaço de nomes.

Respostas

Name Tipo Description
200 OK

EHNamespace

Espaço de nomes criado com êxito.
201 Created

EHNamespace

Pedido de criação de espaço de nomes aceite.
202 Accepted

Pedido de criação ou atualização do espaço de nomes aceite.
Other Status Codes

ErrorResponse

Resposta de erro do Eventhub que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

NamespaceCreate

Pedido de amostra

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

Resposta da amostra

Código de estado:
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/"
  }
}
Código de estado:
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/"
  }
}
Código de estado:
202

Definições

Name Description
ConnectionState

Detalhes sobre o estado da ligação.
createdByType

O tipo de identidade que criou o recurso.
EHNamespace

Item de Espaço de Nomes Único na Lista ou Em Operação Obter
EndPointProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.
keySource

Enumera o valor possível de keySource para Encriptação
KeyVaultProperties

Propriedades do KeyVault
ManagedServiceIdentityType

Tipo de identidade de serviço gerida.
PrivateEndpoint

O recurso ponto final privado para esta Ligação.
PrivateEndpointConnection

Lista de ligações de pontos finais privados.
PrivateLinkConnectionStatus

Estado da ligação.
PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado.
Sku

Propriedades do recurso sku
SkuName

Nome deste SKU.
SkuTier

O escalão de faturação deste SKU específico.
systemData

Metadados relativos à criação e última modificação do recurso.
TlsVersion

A versão mínima do TLS para o cluster suportar, por exemplo, "1.2"
UserAssignedIdentity

Valor do Dicionário Reconhecido.

ConnectionState

Detalhes sobre o estado da ligação.

Name Tipo Description
description

string

Descrição do estado da ligação.
status

PrivateLinkConnectionStatus

Estado da ligação.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Item de Espaço de Nomes Único na Lista ou Em Operação Obter

Name Tipo Default value Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

ObjectId do KeyVault
identity.tenantId

string

TenantId do KeyVault
identity.type

ManagedServiceIdentityType

Tipo de identidade de serviço gerida.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Propriedades das Identidades Atribuídas pelo Utilizador
location

string

Localização do recurso.
name

string

O nome do recurso
properties.alternateName

string

Nome alternativo especificado quando os nomes de alias e espaço de nomes são os mesmos.
properties.clusterArmId

string

ID arm do cluster do Espaço de Nomes.
properties.createdAt

string

A hora em que o Espaço de Nomes foi criado.
properties.disableLocalAuth

boolean

Esta propriedade desativa a autenticação SAS para o espaço de nomes dos Hubs de Eventos.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Enumera o valor possível de keySource para Encriptação
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Propriedades do KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Ativar a Encriptação de Infraestrutura (Encriptação Dupla)
properties.isAutoInflateEnabled

boolean

Valor que indica se o AutoInflate está ativado para o espaço de nomes do eventhub.
properties.kafkaEnabled

boolean

Valor que indica se o Kafka está ativado para o espaço de nomes do eventhub.
properties.maximumThroughputUnits

integer

Limite superior das unidades de débito quando o AutoInflate está ativado, o valor deve estar entre 0 e 20 unidades de débito. ( "0" se AutoInflateEnabled = true)
properties.metricId

string

Identificador das métricas do Azure Insights.
properties.minimumTlsVersion

TlsVersion

A versão mínima do TLS para o cluster suportar, por exemplo, "1.2"
properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de ligações de pontos finais privados.
properties.provisioningState

string

Estado de aprovisionamento do Espaço de Nomes.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado.
properties.serviceBusEndpoint

string

Ponto final que pode utilizar para realizar operações do Service Bus.
properties.status

string

Estado do Espaço de Nomes.
properties.updatedAt

string

A hora em que o Espaço de Nomes foi atualizado.
properties.zoneRedundant

boolean

Ativar esta propriedade cria um Espaço de Nomes dos Hubs de Eventos Padrão em regiões suportadas nas zonas de disponibilidade.
sku

Sku

Propriedades do recurso sku
systemData

systemData

Os metadados do sistema relacionados com este recurso.
tags

object

Etiquetas de recursos.
type

string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.

Name Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name Tipo Description
error

ErrorDetail

O objeto de erro.

keySource

Enumera o valor possível de keySource para Encriptação

Name Tipo Description
Microsoft.KeyVault

string

KeyVaultProperties

Propriedades do KeyVault

Name Tipo Description
identity.userAssignedIdentity

string

ID do ARM da Identidade do utilizador selecionado para encriptação
keyName

string

Nome da Chave do KeyVault
keyVaultUri

string

Uri de KeyVault
keyVersion

string

Versão da Chave

ManagedServiceIdentityType

Tipo de identidade de serviço gerida.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

O recurso ponto final privado para esta Ligação.

Name Tipo Description
id

string

O identificador do ARM para o Ponto Final Privado.

PrivateEndpointConnection

Lista de ligações de pontos finais privados.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

A localização geográfica onde o recurso se encontra
name

string

O nome do recurso
properties.privateEndpoint

PrivateEndpoint

O recurso ponto final privado para esta Ligação.
properties.privateLinkServiceConnectionState

ConnectionState

Detalhes sobre o estado da ligação.
properties.provisioningState

EndPointProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.
systemData

systemData

Os metadados do sistema relacionados com este recurso.
type

string

O tipo de recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Estado da ligação.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado.

Name Tipo Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Propriedades do recurso sku

Name Tipo Description
capacity

integer

As unidades de débito dos Hubs de Eventos para escalões Básico ou Standard, em que o valor deve ser de 0 a 20 unidades de débito. As unidades premium dos Hubs de Eventos para o escalão Premium, em que o valor deve ser de 0 a 10 unidades premium.
name

SkuName

Nome deste SKU.
tier

SkuTier

O escalão de faturação deste SKU específico.

SkuName

Nome deste SKU.

Name Tipo Description
Basic

string

Premium

string

Standard

string

SkuTier

O escalão de faturação deste SKU específico.

Name Tipo Description
Basic

string

Premium

string

Standard

string

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TlsVersion

A versão mínima do TLS para o cluster suportar, por exemplo, "1.2"

Name Tipo Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Valor do Dicionário Reconhecido.

Name Tipo Description
clientId

string

ID de cliente da identidade atribuída pelo utilizador
principalId

string

ID principal da identidade atribuída pelo utilizador