Namespaces - Create Or Update

Referencia

Service:: Service Bus

API Version:: 2021-11-01

Crea o actualiza un espacio de nombres de servicio. Una vez creado, el manifiesto de recursos de este espacio de nombres es inmutable. Esta operación es idempotente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	El espacio de nombres.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
identity.type		ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Propiedades de identidades asignadas por el usuario
properties.alternateName		string	Nombre alternativo para el espacio de nombres
properties.disableLocalAuth		boolean	Esta propiedad deshabilita la autenticación de SAS para el espacio de nombres de Service Bus.
properties.encryption.keySource		keySource	Enumera el valor posible de keySource para el cifrado.
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Propiedades de KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Habilitación del cifrado de infraestructura (cifrado doble)
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado.
properties.zoneRedundant		boolean	Al habilitar esta propiedad, se crea un espacio de nombres premium de Service Bus en las regiones que admiten zonas de disponibilidad.
sku		SBSku	Propiedades de la SKU
tags		object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	SBNamespace	Espacio de nombres creado correctamente.
201 Created	SBNamespace	Solicitud de creación de espacio de nombres aceptada.
202 Accepted		Se aceptó la solicitud de creación o actualización del espacio de nombres.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

NameSpaceCreate

Sample Request

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

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.servicebus.fluent.models.SBNamespaceInner;
import com.azure.resourcemanager.servicebus.models.SBSku;
import com.azure.resourcemanager.servicebus.models.SkuName;
import com.azure.resourcemanager.servicebus.models.SkuTier;
import java.util.HashMap;
import java.util.Map;

/** Samples for Namespaces CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/
     * SBNameSpaceCreate.json
     */
    /**
     * Sample code: NameSpaceCreate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getNamespaces().createOrUpdate("ArunMonocle",
            "sdk-Namespace2924",
            new SBNamespaceInner().withLocation("South Central US").withTags(mapOf("tag1", "value1", "tag2", "value2"))
                .withSku(new SBSku().withName(SkuName.STANDARD).withTier(SkuTier.STANDARD)),
            Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_name_space_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.namespaces.begin_create_or_update(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace2924",
        parameters={
            "location": "South Central US",
            "sku": {"name": "Standard", "tier": "Standard"},
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCreate.json
if __name__ == "__main__":
    main()

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

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCreate.json
func ExampleNamespacesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewNamespacesClient().BeginCreateOrUpdate(ctx, "ArunMonocle", "sdk-Namespace2924", armservicebus.SBNamespace{
		Location: to.Ptr("South Central US"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		SKU: &armservicebus.SBSKU{
			Name: to.Ptr(armservicebus.SKUNameStandard),
			Tier: to.Ptr(armservicebus.SKUTierStandard),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SBNamespace = armservicebus.SBNamespace{
	// 	Name: to.Ptr("sdk-Namespace-2924"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armservicebus.SBNamespaceProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-25T22:26:36.760Z"); return t}()),
	// 		MetricID: to.Ptr("5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ServiceBusEndpoint: to.Ptr("https://sdk-Namespace-2924.servicebus.windows-int.net:443/"),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-25T22:26:36.760Z"); return t}()),
	// 	},
	// 	SKU: &armservicebus.SBSKU{
	// 		Name: to.Ptr(armservicebus.SKUNameStandard),
	// 		Tier: to.Ptr(armservicebus.SKUTierStandard),
	// 	},
	// }
}

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

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
 *
 * @summary Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCreate.json
 */
async function nameSpaceCreate() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace2924";
  const parameters = {
    location: "South Central US",
    sku: { name: "Standard", tier: "Standard" },
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.beginCreateOrUpdateAndWait(
    resourceGroupName,
    namespaceName,
    parameters
  );
  console.log(result);
}

nameSpaceCreate().catch(console.error);

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

Sample Response

Status code:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "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/"
  }
}

Status code:: 201

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "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
  }
}

Status code:: 202

Definiciones

Nombre	Description
ConnectionState	Información de ConnectionState.
createdByType	Tipo de identidad que creó el recurso.
EndPointProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
keySource	Enumera el valor posible de keySource para el cifrado.
KeyVaultProperties	Propiedades para configurar las propiedades de keyVault
ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
PrivateEndpoint	Información de PrivateEndpoint.
PrivateEndpointConnection	Propiedades de PrivateEndpointConnection.
PrivateLinkConnectionStatus	Estado de la conexión.
SBNamespace	Descripción de un recurso de espacio de nombres.
SBSku	SKU del espacio de nombres.
SkuName	Nombre de esta SKU.
SkuTier	El nivel de facturación de esta SKU determinada.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserAssignedIdentity	Valor de diccionario reconocido.

ConnectionState

Información de ConnectionState.

Nombre	Tipo	Description
description	string	Descripción del estado de conexión.
status	PrivateLinkConnectionStatus	Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

keySource

Enumera el valor posible de keySource para el cifrado.

Nombre	Tipo	Description
Microsoft.KeyVault	string

KeyVaultProperties

Propiedades para configurar las propiedades de keyVault

Nombre	Tipo	Description
identity.userAssignedIdentity	string	Id. de ARM de la identidad de usuario seleccionada para el cifrado
keyName	string	Nombre de la clave de KeyVault
keyVaultUri	string	URI de KeyVault
keyVersion	string	Versión de KeyVault

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Información de PrivateEndpoint.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Propiedades de PrivateEndpointConnection.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado para esta conexión.
properties.privateLinkServiceConnectionState	ConnectionState	Detalles sobre el estado de la conexión.
properties.provisioningState	EndPointProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Estado de la conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SBNamespace

Descripción de un recurso de espacio de nombres.

Nombre	Tipo	Valor predeterminado	Description
id	string		Id. de recurso
identity.principalId	string		ObjectId de KeyVault
identity.tenantId	string		TenantId de KeyVault
identity.type	ManagedServiceIdentityType		Tipo de identidad de servicio administrada.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Propiedades de identidades asignadas por el usuario
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso
properties.alternateName	string		Nombre alternativo para el espacio de nombres
properties.createdAt	string		Hora en que se creó el espacio de nombres
properties.disableLocalAuth	boolean		Esta propiedad deshabilita la autenticación de SAS para el espacio de nombres de Service Bus.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Enumera el valor posible de keySource para el cifrado.
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Propiedades de KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Habilitación del cifrado de infraestructura (cifrado doble)
properties.metricId	string		Identificador de las métricas de Azure Insights
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexiones de punto de conexión privado.
properties.provisioningState	string		Estado de aprovisionamiento del espacio de nombres.
properties.serviceBusEndpoint	string		Punto de conexión que puede usar para realizar operaciones de Service Bus.
properties.status	string		Estado del espacio de nombres.
properties.updatedAt	string		Hora en que se actualizó el espacio de nombres.
properties.zoneRedundant	boolean		Al habilitar esta propiedad, se crea un espacio de nombres premium de Service Bus en las regiones que admiten zonas de disponibilidad.
sku	SBSku		Propiedades de la SKU
systemData	systemData		Metadatos del sistema relacionados con este recurso.
tags	object		Etiquetas del recurso
type	string		Tipo de recurso

SBSku

SKU del espacio de nombres.

Nombre	Tipo	Description
capacity	integer	Unidades de mensajería especificadas para el nivel. Para el nivel Premium, la capacidad es de 1,2 y 4.
name	SkuName	Nombre de esta SKU.
tier	SkuTier	El nivel de facturación de esta SKU determinada.

SkuName

Nombre de esta SKU.

Nombre	Tipo	Description
Basic	string
Premium	string
Standard	string

SkuTier

El nivel de facturación de esta SKU determinada.

Nombre	Tipo	Description
Basic	string
Premium	string
Standard	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Valor de diccionario reconocido.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el usuario

Namespaces - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

NameSpaceCreate

Sample Request

Sample Response

Definiciones

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

SBNamespace

SBSku

SkuName

SkuTier

systemData

UserAssignedIdentity

Recursos adicionales