Namespaces - Create Or Update

Serviço:: Service Bus

Versão da API:: 2024-01-01

Cria ou atualiza um namespace de serviço. Depois de criado, o manifesto de recurso desse namespace é imutável. Esta operação é idempotente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	O nome do namespace.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
identity.type		ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Propriedades para identidades atribuídas pelo usuário
properties.alternateName		string	Nome alternativo para namespace
properties.disableLocalAuth		boolean	Essa propriedade desabilita a autenticação SAS para o namespace do Barramento de Serviço.
properties.encryption.keySource		keySource	Enumera o valor possível de keySource for Encryption
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Propriedades do KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Habilitar Criptografia de Infraestrutura (Criptografia Dupla)
properties.minimumTlsVersion		TlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
properties.premiumMessagingPartitions		integer (int32)	O número de partições de um namespace do Barramento de Serviço. Essa propriedade só é aplicável aos namespaces de SKU Premium. O valor padrão é 1 e os valores possíveis são 1, 2 e 4
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privado.
properties.publicNetworkAccess		PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
properties.zoneRedundant		boolean	Essa propriedade reflete se a redundância de zona foi habilitada para namespaces em regiões que dão suporte a zonas de disponibilidade.
sku		SBSku	Propriedades do SKU
tags		object	Etiquetas de recursos

Respostas

Nome	Tipo	Description
200 OK	SBNamespace	Namespace criado com êxito.
201 Created	SBNamespace	Solicitação de criação de namespace aceita.
202 Accepted		Solicitação de criação ou atualização de namespace aceita.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NameSpaceCreate

PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace2924?api-version=2024-01-01

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "premiumMessagingPartitions": 2
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceCreate.json
// this example is just showing the usage of "Namespaces_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ServiceBusNamespaceResource
ServiceBusNamespaceCollection collection = resourceGroupResource.GetServiceBusNamespaces();

// invoke the operation
string namespaceName = "sdk-Namespace2924";
ServiceBusNamespaceData data = new ServiceBusNamespaceData(new AzureLocation("South Central US"))
{
    Sku = new ServiceBusSku(ServiceBusSkuName.Premium)
    {
        Tier = ServiceBusSkuTier.Premium,
        Capacity = 4,
    },
    PremiumMessagingPartitions = 2,
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2"
    },
};
ArmOperation<ServiceBusNamespaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, namespaceName, data);
ServiceBusNamespaceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusNamespaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:36.76Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2",
    "premiumMessagingPartitions": 2
  }
}

Código de status:: 201

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:36.76Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "disableLocalAuth": false,
    "minimumTlsVersion": "1.2",
    "premiumMessagingPartitions": 2
  }
}

Código de status:: 202

Definições

Nome	Description
ConnectionState	Informações do ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
Error	O objeto de erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	A resposta de erro de gerenciamento de recursos.
keySource	Enumera o valor possível de keySource for Encryption
KeyVaultProperties	Propriedades para configurar propriedades keyVault
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
PrivateEndpoint	Informações do PrivateEndpoint.
PrivateEndpointConnection	Propriedades do PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status da conexão.
PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
SBNamespace	Descrição de um recurso de namespace.
SBSku	SKU do namespace.
SkuName	Nome dessa SKU.
SkuTier	A camada de cobrança 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 dar suporte, por exemplo, '1.2'
UserAssignedIdentity	Valor reconhecido do Dicionário.

ConnectionState

Objeto

Informações do ConnectionState.

Nome	Tipo	Description
description	string	Descrição do estado da conexão.
status	PrivateLinkConnectionStatus	Status da conexão.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Enumeração

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Objeto

O objeto de erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Objeto

A resposta de erro de gerenciamento de recursos.

Nome	Tipo	Description
error	Error	O objeto de erro.

keySource

Enumeração

Enumera o valor possível de keySource for Encryption

Valor	Description
Microsoft.KeyVault

KeyVaultProperties

Objeto

Propriedades para configurar propriedades keyVault

Nome	Tipo	Description
identity.userAssignedIdentity	string	ID do ARM da identidade do usuário selecionada para criptografia
keyName	string	Nome da chave do KeyVault
keyVaultUri	string	Uri de KeyVault
keyVersion	string	Versão do KeyVault

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Objeto

Informações do PrivateEndpoint.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado.

PrivateEndpointConnection

Objeto

Propriedades do PrivateEndpointConnection.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado para esta conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeração

Status da conexão.

Valor	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeração

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.

Valor	Description
Disabled
Enabled
SecuredByPerimeter

SBNamespace

Objeto

Descrição de um recurso de namespace.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso
identity.principalId	string		ObjectId do KeyVault
identity.tenantId	string		TenantId do KeyVault
identity.type	ManagedServiceIdentityType		Tipo de identidade de serviço gerenciado.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Propriedades para identidades atribuídas pelo usuário
location	string		A localização geográfica onde o recurso reside
name	string		Nome do recurso
properties.alternateName	string		Nome alternativo para namespace
properties.createdAt	string (date-time)		A hora em que o namespace foi criado
properties.disableLocalAuth	boolean		Essa propriedade desabilita a autenticação SAS para o namespace do Barramento de Serviço.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Enumera o valor possível de keySource for Encryption
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Propriedades do KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Habilitar Criptografia de Infraestrutura (Criptografia Dupla)
properties.metricId	string		Identificador para métricas do Azure Insights
properties.minimumTlsVersion	TlsVersion		A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
properties.premiumMessagingPartitions	integer (int32)		O número de partições de um namespace do Barramento de Serviço. Essa propriedade só é aplicável aos namespaces de SKU Premium. O valor padrão é 1 e os valores possíveis são 1, 2 e 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado.
properties.provisioningState	string		Estado de provisionamento do namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
properties.serviceBusEndpoint	string		Ponto de extremidade que você pode usar para executar operações do Barramento de Serviço.
properties.status	string		Status do namespace.
properties.updatedAt	string (date-time)		A hora em que o namespace foi atualizado.
properties.zoneRedundant	boolean		Essa propriedade reflete se a redundância de zona foi habilitada para namespaces em regiões que dão suporte a zonas de disponibilidade.
sku	SBSku		Propriedades do SKU
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		Etiquetas de recursos
type	string		Tipo de recurso

SBSku

Objeto

SKU do namespace.

Nome	Tipo	Description
capacity	integer (int32)	Unidades de mensagens para o namespace premium do barramento de serviço. As capacidades válidas são {1, 2, 4, 8, 16} múltiplos da configuração properties.premiumMessagingPartitions. Por exemplo, se properties.premiumMessagingPartitions for 1, os valores de capacidade possíveis serão 1, 2, 4, 8 e 16. Se properties.premiumMessagingPartitions for 4, os valores de capacidade possíveis serão 4, 8, 16, 32 e 64
name	SkuName	Nome dessa SKU.
tier	SkuTier	A camada de cobrança deste SKU específico.

SkuName

Enumeração

Nome dessa SKU.

Valor	Description
Basic
Premium
Standard

SkuTier

Enumeração

A camada de cobrança deste SKU específico.

Valor	Description
Basic
Premium
Standard

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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

Enumeração

A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'

Valor	Description
1.0
1.1
1.2

UserAssignedIdentity

Objeto

Valor reconhecido do Dicionário.

Nome	Tipo	Description
clientId	string	ID do cliente da identidade atribuída pelo usuário
principalId	string	ID da entidade de segurança da identidade atribuída pelo usuário

Compartilhar via

Namespaces - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

NameSpaceCreate

Solicitação de exemplo

Resposta de exemplo

Definições

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity