Namespaces - Create Or Update

Service:

Service Bus

API Version:

2021-11-01

Hiermee maakt of werkt u een servicenaamruimte bij. Na het maken is het resourcemanifest van deze naamruimte onveranderbaar. Deze bewerking is idempotent.

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

URI-parameters

Name	In	Vereist	Type	Description
namespaceName	path	True	string	De naam van de naamruimte.
resourceGroupName	path	True	string	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De geografische locatie waar de resource zich bevindt
identity.type		ManagedServiceIdentityType	Type beheerde service-identiteit.
identity.userAssignedIdentities		<string,  UserAssignedIdentity>	Eigenschappen voor door de gebruiker toegewezen identiteiten
properties.alternateName		string	Alternatieve naam voor naamruimte
properties.disableLocalAuth		boolean	Met deze eigenschap wordt SAS-verificatie voor de Service Bus-naamruimte uitgeschakeld.
properties.encryption.keySource		keySource	Inventariseert de mogelijke waarde van keySource voor versleuteling
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Eigenschappen van KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Infrastructuurversleuteling inschakelen (dubbele versleuteling)
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lijst met privé-eindpuntverbindingen.
properties.zoneRedundant		boolean	Als u deze eigenschap inschakelt, maakt u een Premium Service Bus-naamruimte in ondersteunde beschikbaarheidszones.
sku		SBSku	Eigenschappen van SKU
tags		object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	SBNamespace	De naamruimte is gemaakt.
201 Created	SBNamespace	Aanvraag voor het maken van naamruimten is geaccepteerd.
202 Accepted		Aanvraag voor het maken of bijwerken van naamruimten is geaccepteerd.
Other Status Codes	ErrorResponse	ServiceBus-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

NameSpaceCreate

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

Definities

Name	Description
ConnectionState	ConnectionState-informatie.
createdByType	Het type identiteit waarmee de resource is gemaakt.
EndPointProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
Error	Het foutobject.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Het foutantwoord voor resourcebeheer.
keySource	Inventariseert de mogelijke waarde van keySource voor versleuteling
KeyVaultProperties	Eigenschappen voor het configureren van keyVault-eigenschappen
ManagedServiceIdentityType	Type beheerde service-identiteit.
PrivateEndpoint	PrivateEndpoint-informatie.
PrivateEndpointConnection	Eigenschappen van privateEndpointConnection.
PrivateLinkConnectionStatus	Status van de verbinding.
SBNamespace	Beschrijving van een naamruimteresource.
SBSku	SKU van de naamruimte.
SkuName	Naam van deze SKU.
SkuTier	De factureringslaag van deze specifieke SKU.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
UserAssignedIdentity	Herkende woordenlijstwaarde.

ConnectionState

ConnectionState-informatie.

Name	Type	Description
description	string	Beschrijving van de verbindingsstatus.
status	PrivateLinkConnectionStatus	Status van de verbinding.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

Het foutobject.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Het foutantwoord voor resourcebeheer.

Name	Type	Description
error	Error	Het foutobject.

keySource

Inventariseert de mogelijke waarde van keySource voor versleuteling

Name	Type	Description
Microsoft.KeyVault	string

KeyVaultProperties

Eigenschappen voor het configureren van keyVault-eigenschappen

Name	Type	Description
identity.userAssignedIdentity	string	ARM-id van gebruikersidentiteit geselecteerd voor versleuteling
keyName	string	Naam van de sleutel van KeyVault
keyVaultUri	string	URI van KeyVault
keyVersion	string	Versie van KeyVault

ManagedServiceIdentityType

Type beheerde service-identiteit.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

PrivateEndpoint-informatie.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt.

PrivateEndpointConnection

Eigenschappen van privateEndpointConnection.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource voor deze verbinding.
properties.privateLinkServiceConnectionState	ConnectionState	Details over de status van de verbinding.
properties.provisioningState	EndPointProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

PrivateLinkConnectionStatus

Status van de verbinding.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SBNamespace

Beschrijving van een naamruimteresource.

Name	Type	Standaardwaarde	Description
id	string		Resource-id
identity.principalId	string		ObjectId van de KeyVault
identity.tenantId	string		TenantId van de KeyVault
identity.type	ManagedServiceIdentityType		Type beheerde service-identiteit.
identity.userAssignedIdentities	<string,  UserAssignedIdentity>		Eigenschappen voor door de gebruiker toegewezen identiteiten
location	string		De geografische locatie waar de resource zich bevindt
name	string		Resourcenaam
properties.alternateName	string		Alternatieve naam voor naamruimte
properties.createdAt	string		Het tijdstip waarop de naamruimte is gemaakt
properties.disableLocalAuth	boolean		Met deze eigenschap wordt SAS-verificatie voor de Service Bus-naamruimte uitgeschakeld.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Inventariseert de mogelijke waarde van keySource voor versleuteling
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Eigenschappen van KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Infrastructuurversleuteling inschakelen (dubbele versleuteling)
properties.metricId	string		Id voor metrische gegevens van Azure Insights
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lijst met privé-eindpuntverbindingen.
properties.provisioningState	string		Inrichtingsstatus van de naamruimte.
properties.serviceBusEndpoint	string		Eindpunt dat u kunt gebruiken om Service Bus-bewerkingen uit te voeren.
properties.status	string		Status van de naamruimte.
properties.updatedAt	string		Het tijdstip waarop de naamruimte is bijgewerkt.
properties.zoneRedundant	boolean		Als u deze eigenschap inschakelt, maakt u een Premium Service Bus-naamruimte in ondersteunde beschikbaarheidszones.
sku	SBSku		Eigenschappen van SKU
systemData	systemData		De systeemmetagegevens met betrekking tot deze resource.
tags	object		Resourcetags
type	string		Resourcetype

SBSku

SKU van de naamruimte.

Name	Type	Description
capacity	integer	De opgegeven berichteneenheden voor de laag. Voor de Premium-laag is de capaciteit 1, 2 en 4.
name	SkuName	Naam van deze SKU.
tier	SkuTier	De factureringslaag van deze specifieke SKU.

SkuName

Naam van deze SKU.

Name	Type	Description
Basic	string
Premium	string
Standard	string

SkuTier

De factureringslaag van deze specifieke SKU.

Name	Type	Description
Basic	string
Premium	string
Standard	string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het type identiteit dat de resource het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAssignedIdentity

Herkende woordenlijstwaarde.

Name	Type	Description
clientId	string	Client-id van door de gebruiker toegewezen identiteit
principalId	string	Principal-id van door de gebruiker toegewezen identiteit