Namespaces - Create Or Update

Referenz

Dienst:: Service Bus

API-Version:: 2024-01-01

Erstellt oder aktualisiert einen Dienstnamespace. Nach der Erstellung ist das Ressourcenmanifest dieses Namespace unveränderlich. Dieser Vorgang ist idempotent.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string	Der Namespacename.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
identity.type		ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Eigenschaften für vom Benutzer zugewiesene Identitäten
properties.alternateName		string	Alternativer Name für Namespace
properties.disableLocalAuth		boolean	Diese Eigenschaft deaktiviert die SAS-Authentifizierung für den Service Bus-Namespace.
properties.encryption.keySource		keySource	Listet den möglichen Wert von keySource für Verschlüsselung auf.
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Eigenschaften von KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Aktivieren der Infrastrukturverschlüsselung (Doppelte Verschlüsselung)
properties.minimumTlsVersion		TlsVersion	Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
properties.premiumMessagingPartitions		integer (int32)	Die Anzahl der Partitionen eines Service Bus-Namespaces. Diese Eigenschaft gilt nur für Premium-SKU-Namespaces. Der Standardwert ist 1 und mögliche Werte sind 1, 2 und 4.
properties.privateEndpointConnections		PrivateEndpointConnection[]	Liste der privaten Endpunktverbindungen.
properties.publicNetworkAccess		PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.zoneRedundant		boolean	Durch Aktivieren dieser Eigenschaft wird ein Premium Service Bus-Namespace in regionen unterstützter Verfügbarkeitszonen erstellt.
sku		SBSku	Eigenschaften der SKU
tags		object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	SBNamespace	Der Namespace wurde erfolgreich erstellt.
201 Created	SBNamespace	Namespace create request accepted.
202 Accepted		Namespace-Erstellungs- oder Aktualisierungsanforderung akzeptiert.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Statuscode:: 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
  }
}

Statuscode:: 202

Definitionen

Name	Beschreibung
ConnectionState	ConnectionState-Informationen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
keySource	Listet den möglichen Wert von keySource für Verschlüsselung auf.
KeyVaultProperties	Eigenschaften zum Konfigurieren von keyVault-Eigenschaften
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
PrivateEndpoint	PrivateEndpoint-Informationen.
PrivateEndpointConnection	Eigenschaften der PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status der Verbindung.
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
SBNamespace	Beschreibung einer Namespaceressource.
SBSku	SKU des Namespace.
SkuName	Name dieser SKU.
SkuTier	Die Abrechnungsebene dieser speziellen SKU.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TlsVersion	Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
UserAssignedIdentity	Erkannter Wörterbuchwert.

ConnectionState

Objekt

ConnectionState-Informationen.

Name	Typ	Beschreibung
description	string	Beschreibung des Verbindungszustands.
status	PrivateLinkConnectionStatus	Status der Verbindung.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Enumeration

Bereitstellungsstatus der privaten Endpunktverbindung.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

keySource

Enumeration

Listet den möglichen Wert von keySource für Verschlüsselung auf.

Wert	Beschreibung
Microsoft.KeyVault

KeyVaultProperties

Objekt

Eigenschaften zum Konfigurieren von keyVault-Eigenschaften

Name	Typ	Beschreibung
identity.userAssignedIdentity	string	ARM-ID der Benutzeridentität, die für die Verschlüsselung ausgewählt ist
keyName	string	Name des Schlüssels von KeyVault
keyVaultUri	string	URI von KeyVault
keyVersion	string	Version von KeyVault

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Objekt

PrivateEndpoint-Informationen.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Objekt

Eigenschaften der PrivateEndpointConnection.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.privateEndpoint	PrivateEndpoint	Die Private Endpoint-Ressource für diese Verbindung.
properties.privateLinkServiceConnectionState	ConnectionState	Details zum Status der Verbindung.
properties.provisioningState	EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeration

Status der Verbindung.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeration

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.

Wert	Beschreibung
Disabled
Enabled
SecuredByPerimeter

SBNamespace

Objekt

Beschreibung einer Namespaceressource.

Name	Typ	Standardwert	Beschreibung
id	string		Ressourcen-ID
identity.principalId	string		ObjectId aus keyVault
identity.tenantId	string		TenantId aus keyVault
identity.type	ManagedServiceIdentityType		Typ der verwalteten Dienstidentität.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Eigenschaften für vom Benutzer zugewiesene Identitäten
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Ressourcenname
properties.alternateName	string		Alternativer Name für Namespace
properties.createdAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace erstellt wurde
properties.disableLocalAuth	boolean		Diese Eigenschaft deaktiviert die SAS-Authentifizierung für den Service Bus-Namespace.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Listet den möglichen Wert von keySource für Verschlüsselung auf.
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Eigenschaften von KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Aktivieren der Infrastrukturverschlüsselung (Doppelte Verschlüsselung)
properties.metricId	string		Bezeichner für Azure Insights-Metriken
properties.minimumTlsVersion	TlsVersion		Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
properties.premiumMessagingPartitions	integer (int32)		Die Anzahl der Partitionen eines Service Bus-Namespaces. Diese Eigenschaft gilt nur für Premium-SKU-Namespaces. Der Standardwert ist 1 und mögliche Werte sind 1, 2 und 4.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen.
properties.provisioningState	string		Bereitstellungsstatus des Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.serviceBusEndpoint	string		Endpunkt, den Sie zum Ausführen von ServiceBus-Vorgängen verwenden können.
properties.status	string		Status des Namespace.
properties.updatedAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace aktualisiert wurde.
properties.zoneRedundant	boolean		Durch Aktivieren dieser Eigenschaft wird ein Premium Service Bus-Namespace in regionen unterstützter Verfügbarkeitszonen erstellt.
sku	SBSku		Eigenschaften der SKU
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object		Ressourcentags
type	string		Ressourcentyp

SBSku

Objekt

SKU des Namespace.

Name	Typ	Beschreibung
capacity	integer (int32)	Messaging-Einheiten für Ihren Servicebus Premium-Namespace. Gültige Kapazitäten sind {1, 2, 4, 8, 16} Vielfache Ihrer Eigenschaften.premiumMessagingPartitions-Einstellung. Wenn "properties.premiumMessagingPartitions" beispielsweise 1 ist, sind mögliche Kapazitätswerte 1, 2, 4, 8 und 16. Wenn properties.premiumMessagingPartitions 4 ist, sind mögliche Kapazitätswerte 4, 8, 16, 32 und 64.
name	SkuName	Name dieser SKU.
tier	SkuTier	Die Abrechnungsebene dieser speziellen SKU.

SkuName

Enumeration

Name dieser SKU.

Wert	Beschreibung
Basic
Premium
Standard

SkuTier

Enumeration

Die Abrechnungsebene dieser speziellen SKU.

Wert	Beschreibung
Basic
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TlsVersion

Enumeration

Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"

Wert	Beschreibung
1.0
1.1
1.2

UserAssignedIdentity

Objekt

Erkannter Wörterbuchwert.

Name	Typ	Beschreibung
clientId	string	Client-ID der vom Benutzer zugewiesenen Identität
principalId	string	Prinzipal-ID der vom Benutzer zugewiesenen Identität

Freigeben über

Namespaces - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

NameSpaceCreate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity

Zusätzliche Ressourcen