Private Endpoint Connections - Create Or Update

指定された名前のプライベート エンドポイント接続を承認または拒否します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-15

URI パラメーター

名前 / 必須 説明
accountName
path True

string

Cosmos DB データベース アカウント名。

正規表現パターン: ^[a-z0-9]+(-[a-z0-9]+)*

privateEndpointConnectionName
path True

string

プライベート エンドポイント接続の名前。

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
properties.groupId

string

プライベート エンドポイントのグループ ID。

properties.privateEndpoint

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

properties.provisioningState

string

プライベート エンドポイントのプロビジョニング状態。

応答

名前 説明
200 OK

PrivateEndpointConnection

プライベート エンドポイント接続が正常に承認または拒否されました。

202 Accepted

受理されました。 プライベート エンドポイント接続の更新は非同期的に完了します。

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Approve or reject a private endpoint connection with a given name.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-15

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com"
    }
  }
}

応答のサンプル

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName",
  "name": "privateEndpointConnectionName",
  "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-approved",
      "actionsRequired": "None"
    },
    "groupId": "Sql",
    "provisioningState": "Succeeded"
  }
}

定義

名前 説明
ErrorResponse

エラー応答。

PrivateEndpointConnection

プライベート エンドポイント接続

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

ErrorResponse

エラー応答。

名前 説明
code

string

エラー コード。

message

string

操作が失敗した理由を示すエラー メッセージ。

PrivateEndpointConnection

プライベート エンドポイント接続

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.groupId

string

プライベート エンドポイントのグループ ID。

properties.privateEndpoint

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

properties.provisioningState

string

プライベート エンドポイントのプロビジョニング状態。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

名前 説明
id

string

プライベート エンドポイントのリソース ID。

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

名前 説明
actionsRequired

string

基本的なワークフローを超えて必要なアクション (承認/拒否/切断)

description

string

プライベート リンク サービスの接続の説明。

status

string

プライベート リンク サービスの接続状態。