次の方法で共有

Shared Private Link Resources - Create Or Update

サービス:
Search Management
API バージョン:
2025-05-01

特定のリソース グループ内の検索サービスによって管理される共有プライベート リンク リソースの作成または更新を開始します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2025-05-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
sharedPrivateLinkResourceName
 path True

string

指定したリソース グループ内の Azure AI Search サービスによって管理される共有プライベート リンク リソースの名前。
subscriptionId
 path True

string

Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API またはポータルから取得できます。
api-version
 query True

string

各要求に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string (uuid)

この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

要求本文

名前 型 説明
properties

SharedPrivateLinkResourceProperties

Azure AI Search サービスによって管理される共有プライベート リンク リソースのプロパティについて説明します。

応答

名前 型 説明
200 OK

SharedPrivateLinkResource

作成または更新された共有プライベート リンク リソースの詳細。
202 Accepted

共有プライベート リンク リソースの作成または更新操作が受け入れられ、非同期的に完了します。
Other Status Codes

CloudError

HTTP 400 (無効な要求): 指定された共有プライベート リンク リソース名または共有プライベート リンク リソース定義が無効です。詳細については、応答のエラー コードとメッセージを参照してください。 HTTP 404 (見つかりません): サブスクリプション、リソース グループ、検索サービス、または共有プライベート リンク リソースが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

SharedPrivateLinkResourceCreateOrUpdate

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-05-01

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

応答のサンプル

状態コード:
202 
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
状態コード:
200 
{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

定義

名前 説明
CloudError

API エラーに関する情報が含まれています。
CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。
createdByType

リソースを作成した ID の種類。
SharedPrivateLinkResource

Azure AI Search サービスによって管理される共有プライベート リンク リソースについて説明します。
SharedPrivateLinkResourceProperties

Azure AI Search サービスによって管理されている既存の共有プライベート リンク リソースのプロパティについて説明します。
SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
systemData

リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

API エラーに関する情報が含まれています。

名前 型 説明
error

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。
message

string

問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前 型 説明
code

string

HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。
details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。
message

string

エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target

string

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

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

SharedPrivateLinkResource

Object

Azure AI Search サービスによって管理される共有プライベート リンク リソースについて説明します。

名前 型 説明
id

string (arm-id)

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

string

リソースの名前
properties

SharedPrivateLinkResourceProperties

Azure AI Search サービスによって管理される共有プライベート リンク リソースのプロパティについて説明します。
systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type

string

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

SharedPrivateLinkResourceProperties

Object

Azure AI Search サービスによって管理されている既存の共有プライベート リンク リソースのプロパティについて説明します。

名前 型 説明
groupId

string

共有プライベート リンク リソースの対象となるリソースのプロバイダーからのグループ ID。
privateLinkResourceId

string

共有プライベート リンク リソースの対象となるリソースのリソース ID。
provisioningState

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
requestMessage

string

共有プライベート リンク リソースの承認を要求するためのメッセージ。
resourceRegion

string

任意。 共有プライベート リンクを作成するリソースの Azure Resource Manager の場所を指定するために使用できます。 これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。
status

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

SharedPrivateLinkResourceProvisioningState

列挙

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

値 説明
Updating

共有プライベート リンク リソースは、完全に機能するために、他のリソースと共に作成中です。
Deleting

共有プライベート リンク リソースは削除中です。
Failed

共有プライベート リンク リソースをプロビジョニングまたは削除できませんでした。
Succeeded

共有プライベート リンク リソースのプロビジョニングが完了し、承認の準備が整いました。
Incomplete

共有プライベート リンク リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。

SharedPrivateLinkResourceStatus

列挙

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

値 説明
Pending

共有プライベート リンク リソースが作成され、承認が保留中です。
Approved

共有プライベート リンク リソースが承認され、使用できる状態になります。
Rejected

共有プライベート リンク リソースは拒否され、使用できません。
Disconnected

共有プライベート リンク リソースがサービスから削除されました。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。