Private Endpoint Connection - Update

既存のプライベート エンドポイント接続のプロパティを更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-06-01

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

Batch アカウントの名前。

Regex pattern: ^[a-zA-Z0-9]+$

privateEndpointConnectionName
path True
  • string

プライベート エンドポイント接続名。 これは、アカウント内で一意である必要があります。

Regex pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$

resourceGroupName
path True
  • string

Batch アカウントを含むリソース グループの名前。

subscriptionId
path True
  • string

Azure サブスクリプション ID。 これは GUID 形式の文字列です (例: 00000000-0000-0000-0000-0000-000000000000)

api-version
query True
  • string

HTTP 要求で使用する API バージョン。

要求ヘッダー

Name Required Type Description
If-Match
  • string

更新するプライベート エンドポイント接続の状態 (ETag) バージョン。 操作を無条件に適用するには、この値を省略するか、"*" に設定できます。

要求本文

Name Type Description
properties.privateLinkServiceConnectionState

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

応答

Name Type Description
200 OK

操作に成功しました。 応答には PrivateEndpointConnection が含まれています。

202 Accepted

操作は受け入れられ、バックグラウンドで実行されます。

Headers

  • Location: string
  • Retry-After: integer
204 No Content

操作に成功しました。

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

UpdatePrivateEndpointConnection

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0?api-version=2022-06-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
    },
    "groupIds": [
      "batchAccount"
    ],
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}
Retry-After: 15
Location: https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2022-01-01

定義

CloudError

Batch サービスからのエラー応答。

CloudErrorBody

Batch サービスからのエラー応答。

PrivateEndpoint

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

PrivateEndpointConnection

プライベート リンク リソースに関する情報が含まれます。

PrivateEndpointConnectionProvisioningState

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

CloudError

Batch サービスからのエラー応答。

Name Type Description
error

エラー応答の本文。

CloudErrorBody

Batch サービスからのエラー応答。

Name Type Description
code
  • string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

エラーに関するその他の詳細の一覧。

message
  • string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target
  • string

特定のエラーのターゲット。 たとえば、エラーのプロパティの名前です。

PrivateEndpoint

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

Name Type Description
id
  • string

プライベート エンドポイントの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint} の形式です。

PrivateEndpointConnection

プライベート リンク リソースに関する情報が含まれます。

Name Type Description
etag
  • string

コンカレンシー ステートメントに使用されるリソースの ETag。

id
  • string

リソースの ID。

name
  • string

リソースの名前。

properties.groupIds
  • string[]

プライベート エンドポイント接続のグループ ID。
値のグループ ID は 1 つだけです。

properties.privateEndpoint

プライベート エンドポイントの ARM リソース識別子。
プライベート エンドポイント接続のプライベート エンドポイント。

properties.privateLinkServiceConnectionState

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

properties.provisioningState

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

type
  • string

リソースの型。

PrivateEndpointConnectionProvisioningState

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

Name Type Description
Cancelled
  • string

ユーザーが接続の作成を取り消しました。

Creating
  • string

接続が作成されています。

Deleting
  • string

接続が削除されています。

Failed
  • string

ユーザーが接続の更新を要求し、失敗しました。 更新操作を再試行できます。

Succeeded
  • string

接続の状態は最終的であり、状態が [承認済み] の場合は使用できる状態です。

Updating
  • string

ユーザーは接続状態の更新を要求しましたが、更新操作はまだ完了していません。 Batch アカウントを接続するときに接続を参照することはできません。

PrivateLinkServiceConnectionState

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

Name Type Description
actionRequired
  • string

プライベート接続状態で必要なアクション

description
  • string

プライベート接続状態の説明

status

Batch アカウントのプライベート エンドポイント接続の状態

PrivateLinkServiceConnectionStatus

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

Name Type Description
Approved
  • string

プライベート エンドポイント接続が承認され、Batch アカウントへのアクセスに使用できます

Disconnected
  • string

プライベート エンドポイント接続が切断され、Batch アカウントへのアクセスに使用できない

Pending
  • string

プライベート エンドポイント接続が保留中であり、Batch アカウントへのアクセスに使用できない

Rejected
  • string

プライベート エンドポイント接続は拒否され、Batch アカウントへのアクセスに使用できません