Private Endpoint Connections - Create Or Update

참조

서비스:: Service Bus

API 버전:: 2024-01-01

서비스 네임스페이스의 PrivateEndpointConnections를 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	네임스페이스 이름
privateEndpointConnectionName	path	True	string	PrivateEndpointConnection 이름
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.privateEndpoint	PrivateEndpoint	이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
properties.privateLinkServiceConnectionState	ConnectionState	연결 상태에 대한 세부 정보입니다.
properties.provisioningState	EndPointProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.

응답

Name	형식	Description
200 OK	PrivateEndpointConnection	PrivateEndPoint 연결 상태가 성공적으로 생성되었습니다.
201 Created	PrivateEndpointConnection	PrivateEndPoint 연결 상태 업데이트 요청이 수락되었습니다.
202 Accepted	PrivateEndpointConnection	PrivateEndPoint 연결 상태 업데이트 요청이 수락되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 ServiceBus 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

NameSpacePrivateEndPointConnectionCreate

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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/PrivateEndPointConnectionCreate.json
// this example is just showing the usage of "PrivateEndpointConnections_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 ServiceBusNamespaceResource created on azure
// for more information of creating ServiceBusNamespaceResource, please refer to the document of ServiceBusNamespaceResource
string subscriptionId = "subID";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-2924";
ResourceIdentifier serviceBusNamespaceResourceId = ServiceBusNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNamespaceResource serviceBusNamespace = client.GetServiceBusNamespaceResource(serviceBusNamespaceResourceId);

// get the collection of this ServiceBusPrivateEndpointConnectionResource
ServiceBusPrivateEndpointConnectionCollection collection = serviceBusNamespace.GetServiceBusPrivateEndpointConnections();

// invoke the operation
string privateEndpointConnectionName = "privateEndpointConnectionName";
ServiceBusPrivateEndpointConnectionData data = new ServiceBusPrivateEndpointConnectionData
{
    PrivateEndpointId = new ResourceIdentifier("/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"),
    ConnectionState = new ServiceBusPrivateLinkServiceConnectionState
    {
        Status = ServiceBusPrivateLinkConnectionStatus.Rejected,
        Description = "testing",
    },
    ProvisioningState = ServiceBusPrivateEndpointConnectionProvisioningState.Succeeded,
};
ArmOperation<ServiceBusPrivateEndpointConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateEndpointConnectionName, data);
ServiceBusPrivateEndpointConnectionResource 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
ServiceBusPrivateEndpointConnectionData 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

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

상태 코드:: 201

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

상태 코드:: 202

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

정의

Name	Description
ConnectionState	ConnectionState 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
EndPointProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
Error	오류 개체입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	리소스 관리 오류 응답입니다.
PrivateEndpoint	PrivateEndpoint 정보입니다.
PrivateEndpointConnection	PrivateEndpointConnection의 속성입니다.
PrivateLinkConnectionStatus	연결의 상태입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

ConnectionState

Object

ConnectionState 정보입니다.

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

createdByType

열거형

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

값	Description
Application
Key
ManagedIdentity
User

EndPointProvisioningState

열거형

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

값	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Object

오류 개체입니다.

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

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

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

Name	형식	Description
error	Error	오류 개체입니다.

PrivateEndpoint

Object

PrivateEndpoint 정보입니다.

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

PrivateEndpointConnection

Object

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

열거형

연결의 상태입니다.

값	Description
Approved
Disconnected
Pending
Rejected

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

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

다음을 통해 공유

Private Endpoint Connections - Create Or Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

NameSpacePrivateEndPointConnectionCreate

샘플 요청

샘플 응답

정의

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

systemData

추가 리소스