Namespaces - Create Or Update

Odwołanie

Service:: Service Bus

API Version:: 2021-11-01

Tworzy lub aktualizuje przestrzeń nazw usługi. Po utworzeniu manifest zasobu tej przestrzeni nazw jest niezmienny. Ta operacja jest idempotentna.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string	Nazwa przestrzeni nazw.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
identity.type		ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Właściwości tożsamości przypisanych przez użytkownika
properties.alternateName		string	Alternatywna nazwa przestrzeni nazw
properties.disableLocalAuth		boolean	Ta właściwość wyłącza uwierzytelnianie sygnatury dostępu współdzielonego dla przestrzeni nazw usługi Service Bus.
properties.encryption.keySource		keySource	Wylicza możliwą wartość kluczaSource dla szyfrowania
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Właściwości usługi KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Włączanie szyfrowania infrastruktury (podwójne szyfrowanie)
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lista połączeń prywatnego punktu końcowego.
properties.zoneRedundant		boolean	Włączenie tej właściwości powoduje utworzenie przestrzeni nazw usługi Service Bus w warstwie Premium w regionach obsługiwanych stref dostępności.
sku		SBSku	Właściwości jednostki SKU
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SBNamespace	Przestrzeń nazw została pomyślnie utworzona.
201 Created	SBNamespace	Zaakceptowano żądanie tworzenia przestrzeni nazw.
202 Accepted		Zaakceptowane żądanie tworzenia lub aktualizowania przestrzeni nazw.
Other Status Codes	ErrorResponse	Odpowiedź błędu usługi ServiceBus opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ConnectionState	Informacje o stanie połączenia.
createdByType	Typ tożsamości, która utworzyła zasób.
EndPointProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
Error	Obiekt błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd zarządzania zasobami.
keySource	Wylicza możliwą wartość kluczaSource dla szyfrowania
KeyVaultProperties	Właściwości do konfigurowania właściwości usługi KeyVault
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
PrivateEndpoint	Informacje o prywatnym punkcie końcowym.
PrivateEndpointConnection	Właściwości elementu PrivateEndpointConnection.
PrivateLinkConnectionStatus	Stan połączenia.
SBNamespace	Opis zasobu przestrzeni nazw.
SBSku	Jednostka SKU przestrzeni nazw.
SkuName	Nazwa tej jednostki SKU.
SkuTier	Warstwa rozliczeń tej konkretnej jednostki SKU.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentity	Rozpoznana wartość słownika.

ConnectionState

Informacje o stanie połączenia.

Nazwa	Typ	Opis
description	string	Opis stanu połączenia.
status	PrivateLinkConnectionStatus	Stan połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

Obiekt błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd zarządzania zasobami.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

keySource

Wylicza możliwą wartość kluczaSource dla szyfrowania

Nazwa	Typ	Opis
Microsoft.KeyVault	string

KeyVaultProperties

Właściwości do konfigurowania właściwości usługi KeyVault

Nazwa	Typ	Opis
identity.userAssignedIdentity	string	Identyfikator arm tożsamości użytkownika wybranej do szyfrowania
keyName	string	Nazwa klucza z usługi KeyVault
keyVaultUri	string	Identyfikator URI usługi KeyVault
keyVersion	string	Wersja usługi KeyVault

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Informacje o prywatnym punkcie końcowym.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Właściwości elementu PrivateEndpointConnection.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego dla tego połączenia.
properties.privateLinkServiceConnectionState	ConnectionState	Szczegóły dotyczące stanu połączenia.
properties.provisioningState	EndPointProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
systemData	systemData	Dane metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Stan połączenia.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

SBNamespace

Opis zasobu przestrzeni nazw.

Nazwa	Typ	Wartość domyślna	Opis
id	string		Identyfikator zasobu
identity.principalId	string		ObjectId z usługi KeyVault
identity.tenantId	string		TenantId z usługi KeyVault
identity.type	ManagedServiceIdentityType		Typ tożsamości usługi zarządzanej.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Właściwości tożsamości przypisanych przez użytkownika
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.alternateName	string		Alternatywna nazwa przestrzeni nazw
properties.createdAt	string		Czas utworzenia przestrzeni nazw
properties.disableLocalAuth	boolean		Ta właściwość wyłącza uwierzytelnianie sygnatury dostępu współdzielonego dla przestrzeni nazw usługi Service Bus.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Wylicza możliwą wartość kluczaSource dla szyfrowania
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Właściwości usługi KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Włączanie szyfrowania infrastruktury (podwójne szyfrowanie)
properties.metricId	string		Identyfikator metryk usługi Azure Insights
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista połączeń prywatnego punktu końcowego.
properties.provisioningState	string		Stan aprowizacji przestrzeni nazw.
properties.serviceBusEndpoint	string		Punkt końcowy, którego można użyć do wykonywania operacji usługi Service Bus.
properties.status	string		Stan przestrzeni nazw.
properties.updatedAt	string		Czas aktualizacji przestrzeni nazw.
properties.zoneRedundant	boolean		Włączenie tej właściwości powoduje utworzenie przestrzeni nazw usługi Service Bus w warstwie Premium w regionach obsługiwanych stref dostępności.
sku	SBSku		Właściwości jednostki SKU
systemData	systemData		Dane metadane systemowe odnoszące się do tego zasobu.
tags	object		Tagi zasobów
type	string		Typ zasobu

SBSku

Jednostka SKU przestrzeni nazw.

Nazwa	Typ	Opis
capacity	integer	Określone jednostki obsługi komunikatów dla warstwy. W przypadku warstwy Premium pojemność to 1,2 i 4.
name	SkuName	Nazwa tej jednostki SKU.
tier	SkuTier	Warstwa rozliczeń tej konkretnej jednostki SKU.

SkuName

Nazwa tej jednostki SKU.

Nazwa	Typ	Opis
Basic	string
Premium	string
Standard	string

SkuTier

Warstwa rozliczeń tej konkretnej jednostki SKU.

Nazwa	Typ	Opis
Basic	string
Premium	string
Standard	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Rozpoznana wartość słownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika
principalId	string	Identyfikator podmiotu tożsamości przypisanej przez użytkownika

Namespaces - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

NameSpaceCreate

Sample Request

Sample Response

Definicje

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

SBNamespace

SBSku

SkuName

SkuTier

systemData

UserAssignedIdentity

Dodatkowe zasoby