Private Endpoint Connections - Create Or Update
更新與認知服務帳戶相關聯的指定私人端點連線狀態。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-05-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
account
|
path | True |
string |
認知服務帳戶的名稱。 Regex pattern: |
private
|
path | True |
string |
與認知服務帳戶相關聯的私人端點連線名稱 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
location |
string |
私人端點連線的位置 |
properties |
資源屬性。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 -- 成功更新私人端點連線屬性。 |
|
202 Accepted |
HTTP 202 (如果作業已成功啟動,且會以異步方式完成,則接受) 。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
範例
PutPrivateEndpointConnection
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.CognitiveServices/accounts/sto9699/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-05-01
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
"name": "{privateEndpointConnectionName}",
"type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved",
"actionsRequired": "None"
}
}
}
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
"name": "{privateEndpointConnectionName}",
"type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved",
"actionsRequired": "None"
}
}
}
定義
名稱 | Description |
---|---|
created |
建立資源的身分識別類型。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Private |
私人端點資源。 |
Private |
私人端點聯機資源。 |
Private |
PrivateEndpointConnectProperties 的屬性。 |
Private |
目前的布建狀態。 |
Private |
私人端點連線狀態。 |
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
system |
與建立和上次修改資源相關的元數據。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
PrivateEndpoint
私人端點資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼 |
PrivateEndpointConnection
私人端點聯機資源。
名稱 | 類型 | Description |
---|---|---|
etag |
string |
資源 Etag。 |
id |
string |
資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
私人端點連線的位置 |
name |
string |
資源的名稱 |
properties |
資源屬性。 |
|
systemData |
與建立和上次修改資源相關的元數據。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProperties
PrivateEndpointConnectProperties 的屬性。
名稱 | 類型 | Description |
---|---|---|
groupIds |
string[] |
私人鏈接資源群組識別碼。 |
privateEndpoint |
私人端點的資源。 |
|
privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
provisioningState |
私人端點聯機資源的布建狀態。 |
PrivateEndpointConnectionProvisioningState
目前的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要取用者的任何更新。 |
description |
string |
核准/拒絕連線的原因。 |
status |
指出連線是否已由服務的擁有者核准/拒絕/移除。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |