Namespaces - Create Or Update

Référence

Service:: Service Bus

Version d'API:: 2024-01-01

Crée ou met à jour un espace de noms de service. Une fois créé, le manifeste de ressource de cet espace de noms est immuable. Cette opération est idempotente.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namespaceName	path	True	string	Nom de l’espace de noms.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement géographique où réside la ressource
identity.type		ManagedServiceIdentityType	Type d’identité de service managé.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Propriétés des identités affectées par l’utilisateur
properties.alternateName		string	Autre nom pour l’espace de noms
properties.disableLocalAuth		boolean	Cette propriété désactive l’authentification SAP pour l’espace de noms Service Bus.
properties.encryption.keySource		keySource	Énumère la valeur possible de keySource pour le chiffrement
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Propriétés de KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Activer le chiffrement d’infrastructure (double chiffrement)
properties.minimumTlsVersion		TlsVersion	Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
properties.premiumMessagingPartitions		integer (int32)	Nombre de partitions d’un espace de noms Service Bus. Cette propriété s’applique uniquement aux espaces de noms de référence SKU Premium. La valeur par défaut est 1 et les valeurs possibles sont 1, 2 et 4
properties.privateEndpointConnections		PrivateEndpointConnection[]	Liste des connexions de point de terminaison privé.
properties.publicNetworkAccess		PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
properties.zoneRedundant		boolean	L’activation de cette propriété crée un espace de noms Service Bus Premium dans les régions prises en charge par les zones de disponibilité.
sku		SBSku	Propriétés de la référence SKU
tags		object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	SBNamespace	Espace de noms créé avec succès.
201 Created	SBNamespace	Demande de création d’espace de noms acceptée.
202 Accepted		Demande de création ou de mise à jour d’espace de noms acceptée.
Other Status Codes	ErrorResponse	Réponse d’erreur ServiceBus décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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
  }
}

Code d’état:: 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
  }
}

Code d’état:: 202

Définitions

Nom	Description
ConnectionState	Informations ConnectionState.
createdByType	Type d’identité qui a créé la ressource.
EndPointProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
Error	Objet d’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur de gestion des ressources.
keySource	Énumère la valeur possible de keySource pour le chiffrement
KeyVaultProperties	Propriétés pour configurer les propriétés keyVault
ManagedServiceIdentityType	Type d’identité de service managé.
PrivateEndpoint	Informations PrivateEndpoint.
PrivateEndpointConnection	Propriétés de PrivateEndpointConnection.
PrivateLinkConnectionStatus	État de la connexion.
PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
SBNamespace	Description d’une ressource d’espace de noms.
SBSku	Référence SKU de l’espace de noms.
SkuName	Nom de cette référence SKU.
SkuTier	Niveau de facturation de cette référence SKU particulière.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TlsVersion	Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
UserAssignedIdentity	Valeur de dictionnaire reconnue.

ConnectionState

Object

Informations ConnectionState.

Nom	Type	Description
description	string	Description de l’état de connexion.
status	PrivateLinkConnectionStatus	État de la connexion.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Énumération

État d’approvisionnement de la connexion de point de terminaison privé.

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Object

Objet d’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorResponse

Object

Réponse d’erreur de gestion des ressources.

Nom	Type	Description
error	Error	Objet d’erreur.

keySource

Énumération

Énumère la valeur possible de keySource pour le chiffrement

Valeur	Description
Microsoft.KeyVault

KeyVaultProperties

Object

Propriétés pour configurer les propriétés keyVault

Nom	Type	Description
identity.userAssignedIdentity	string	ID ARM de l’identité utilisateur sélectionnée pour le chiffrement
keyName	string	Nom de la clé à partir de KeyVault
keyVaultUri	string	Uri de KeyVault
keyVersion	string	Version de KeyVault

ManagedServiceIdentityType

Énumération

Type d’identité de service managé.

Valeur	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

Informations PrivateEndpoint.

Nom	Type	Description
id	string	Identificateur ARM pour point de terminaison privé.

PrivateEndpointConnection

Object

Propriétés de PrivateEndpointConnection.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState	ConnectionState	Détails sur l’état de la connexion.
properties.provisioningState	EndPointProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
systemData	systemData	Métadonnées système relatives à cette ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

PrivateLinkConnectionStatus

Énumération

État de la connexion.

Valeur	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Énumération

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.

Valeur	Description
Disabled
Enabled
SecuredByPerimeter

SBNamespace

Object

Description d’une ressource d’espace de noms.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource
identity.principalId	string		ObjectId à partir de KeyVault
identity.tenantId	string		TenantId à partir de KeyVault
identity.type	ManagedServiceIdentityType		Type d’identité de service managé.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Propriétés des identités affectées par l’utilisateur
location	string		Emplacement géographique où réside la ressource
name	string		Nom de la ressource
properties.alternateName	string		Autre nom pour l’espace de noms
properties.createdAt	string (date-time)		Heure de création de l’espace de noms
properties.disableLocalAuth	boolean		Cette propriété désactive l’authentification SAP pour l’espace de noms Service Bus.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Énumère la valeur possible de keySource pour le chiffrement
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Propriétés de KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Activer le chiffrement d’infrastructure (double chiffrement)
properties.metricId	string		Identificateur des métriques Azure Insights
properties.minimumTlsVersion	TlsVersion		Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
properties.premiumMessagingPartitions	integer (int32)		Nombre de partitions d’un espace de noms Service Bus. Cette propriété s’applique uniquement aux espaces de noms de référence SKU Premium. La valeur par défaut est 1 et les valeurs possibles sont 1, 2 et 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste des connexions de point de terminaison privé.
properties.provisioningState	string		État d’approvisionnement de l’espace de noms.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
properties.serviceBusEndpoint	string		Point de terminaison que vous pouvez utiliser pour effectuer des opérations Service Bus.
properties.status	string		État de l’espace de noms.
properties.updatedAt	string (date-time)		Heure à laquelle l’espace de noms a été mis à jour.
properties.zoneRedundant	boolean		L’activation de cette propriété crée un espace de noms Service Bus Premium dans les régions prises en charge par les zones de disponibilité.
sku	SBSku		Propriétés de la référence SKU
systemData	systemData		Métadonnées système relatives à cette ressource.
tags	object		Balises de ressource
type	string		Type de ressource

SBSku

Object

Référence SKU de l’espace de noms.

Nom	Type	Description
capacity	integer (int32)	Unités de messagerie pour votre espace de noms Service Bus Premium. Les capacités valides sont {1, 2, 4, 8, 16} multiples de votre paramètre properties.premiumMessagingPartitions. Par exemple, si properties.premiumMessagingPartitions est de 1, les valeurs de capacité possibles sont 1, 2, 4, 8 et 16. Si properties.premiumMessagingPartitions est 4, les valeurs de capacité possibles sont 4, 8, 16, 32 et 64
name	SkuName	Nom de cette référence SKU.
tier	SkuTier	Niveau de facturation de cette référence SKU particulière.

SkuName

Énumération

Nom de cette référence SKU.

Valeur	Description
Basic
Premium
Standard

SkuTier

Énumération

Niveau de facturation de cette référence SKU particulière.

Valeur	Description
Basic
Premium
Standard

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Type d’identité qui a modifié la ressource pour la dernière fois.
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TlsVersion

Énumération

Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».

Valeur	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

Valeur de dictionnaire reconnue.

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur
principalId	string	ID principal de l’identité affectée par l’utilisateur

Partager via

Namespaces - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

NameSpaceCreate

Exemple de requête

Exemple de réponse

Définitions

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity

Ressources supplémentaires