Namespaces - Create Or Update

Service:

Service Bus

API Version:

2021-11-01

서비스 네임스페이스를 만들거나 업데이트합니다. 만든 후 이 네임스페이스의 리소스 매니페스트는 변경할 수 없습니다. 이 작업은 idempotent 방식입니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
namespaceName	path	True	string	네임스페이스 이름입니다.
resourceGroupName	path	True	string	Azure 구독 내의 리소스 그룹 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스가 있는 지리적 위치
identity.type		ManagedServiceIdentityType	관리 서비스 ID의 유형입니다.
identity.userAssignedIdentities		<string,  UserAssignedIdentity>	사용자 할당 ID에 대한 속성
properties.alternateName		string	네임스페이스의 대체 이름
properties.disableLocalAuth		boolean	이 속성은 Service Bus 네임스페이스에 대한 SAS 인증을 사용하지 않도록 설정합니다.
properties.encryption.keySource		keySource	암호화에 사용할 수 있는 keySource 값을 열거합니다.
properties.encryption.keyVaultProperties		KeyVaultProperties[]	KeyVault의 속성
properties.encryption.requireInfrastructureEncryption		boolean	인프라 암호화 사용(이중 암호화)
properties.privateEndpointConnections		PrivateEndpointConnection[]	프라이빗 엔드포인트 연결 목록입니다.
properties.zoneRedundant		boolean	이 속성을 사용하도록 설정하면 지원되는 가용성 영역에 프리미엄 Service Bus 네임스페이스가 만들어집니다.
sku		SBSku	SKU의 속성
tags		object	리소스 태그

응답

Name	형식	Description
200 OK	SBNamespace	네임스페이스를 만들었습니다.
201 Created	SBNamespace	네임스페이스 만들기 요청이 수락되었습니다.
202 Accepted		네임스페이스 만들기 또는 업데이트 요청이 수락되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 ServiceBus 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

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

정의

Name	Description
ConnectionState	ConnectionState 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
EndPointProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
Error	Error 개체.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	리소스 관리 오류 응답입니다.
keySource	암호화에 사용할 수 있는 keySource 값을 열거합니다.
KeyVaultProperties	keyVault 속성을 구성하는 속성
ManagedServiceIdentityType	관리 서비스 ID의 유형입니다.
PrivateEndpoint	PrivateEndpoint 정보입니다.
PrivateEndpointConnection	PrivateEndpointConnection의 속성입니다.
PrivateLinkConnectionStatus	연결의 상태입니다.
SBNamespace	네임스페이스 리소스에 대한 설명입니다.
SBSku	네임스페이스의 SKU입니다.
SkuName	이 SKU의 이름입니다.
SkuTier	이 특정 SKU의 청구 계층입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
UserAssignedIdentity	인식된 사전 값입니다.

ConnectionState

ConnectionState 정보입니다.

Name	형식	Description
description	string	연결 상태에 대한 설명입니다.
status	PrivateLinkConnectionStatus	연결의 상태입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

Error 개체.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

리소스 관리 오류 응답입니다.

Name	형식	Description
error	Error	Error 개체.

keySource

암호화에 사용할 수 있는 keySource 값을 열거합니다.

Name	형식	Description
Microsoft.KeyVault	string

KeyVaultProperties

keyVault 속성을 구성하는 속성

Name	형식	Description
identity.userAssignedIdentity	string	암호화를 위해 선택된 사용자 ID의 ARM ID
keyName	string	KeyVault의 키 이름
keyVaultUri	string	KeyVault의 URI
keyVersion	string	KeyVault 버전

ManagedServiceIdentityType

관리 서비스 ID의 유형입니다.

Name	형식	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

PrivateEndpoint 정보입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트에 대한 ARM 식별자입니다.

PrivateEndpointConnection

PrivateEndpointConnection의 속성입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름입니다.
properties.privateEndpoint	PrivateEndpoint	이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
properties.privateLinkServiceConnectionState	ConnectionState	연결 상태에 대한 세부 정보입니다.
properties.provisioningState	EndPointProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
systemData	systemData	이 리소스와 관련된 시스템 메타 데이터입니다.
type	string	리소스 형식입니다. 예: "Microsoft.EventHub/Namespaces" 또는 "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

연결의 상태입니다.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SBNamespace

네임스페이스 리소스에 대한 설명입니다.

Name	형식	기본값	Description
id	string		리소스 ID
identity.principalId	string		KeyVault의 ObjectId
identity.tenantId	string		KeyVault의 TenantId
identity.type	ManagedServiceIdentityType		관리 서비스 ID의 유형입니다.
identity.userAssignedIdentities	<string,  UserAssignedIdentity>		사용자 할당 ID에 대한 속성
location	string		리소스가 있는 지리적 위치
name	string		리소스 이름
properties.alternateName	string		네임스페이스의 대체 이름
properties.createdAt	string		네임스페이스를 만든 시간
properties.disableLocalAuth	boolean		이 속성은 Service Bus 네임스페이스에 대한 SAS 인증을 사용하지 않도록 설정합니다.
properties.encryption.keySource	keySource	Microsoft.KeyVault	암호화에 사용할 수 있는 keySource 값을 열거합니다.
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault의 속성
properties.encryption.requireInfrastructureEncryption	boolean		인프라 암호화 사용(이중 암호화)
properties.metricId	string		Azure Insights 메트릭에 대한 식별자
properties.privateEndpointConnections	PrivateEndpointConnection[]		프라이빗 엔드포인트 연결 목록입니다.
properties.provisioningState	string		네임스페이스의 프로비전 상태입니다.
properties.serviceBusEndpoint	string		Service Bus 작업을 수행하는 데 사용할 수 있는 엔드포인트입니다.
properties.status	string		네임스페이스의 상태입니다.
properties.updatedAt	string		네임스페이스가 업데이트된 시간입니다.
properties.zoneRedundant	boolean		이 속성을 사용하도록 설정하면 지원되는 가용성 영역에 프리미엄 Service Bus 네임스페이스가 만들어집니다.
sku	SBSku		SKU의 속성
systemData	systemData		이 리소스와 관련된 시스템 메타 데이터입니다.
tags	object		리소스 태그
type	string		리소스 유형

SBSku

네임스페이스의 SKU입니다.

Name	형식	Description
capacity	integer	계층에 대해 지정된 메시징 단위입니다. 프리미엄 계층의 경우 용량은 1,2 및 4입니다.
name	SkuName	이 SKU의 이름입니다.
tier	SkuTier	이 특정 SKU의 청구 계층입니다.

SkuName

이 SKU의 이름입니다.

Name	형식	Description
Basic	string
Premium	string
Standard	string

SkuTier

이 특정 SKU의 청구 계층입니다.

Name	형식	Description
Basic	string
Premium	string
Standard	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스를 마지막으로 수정한 ID 유형입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

UserAssignedIdentity

인식된 사전 값입니다.

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID
principalId	string	사용자 할당 ID의 보안 주체 ID