Private Endpoint Connection - Create Or Update
Létrehoz egy új privát végponti kapcsolatot, vagy frissít egy meglévőt.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
private
|
path | True |
string |
A privát végpontkapcsolat neve. |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Reguláris kifejezési minta: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
id |
string |
Privát végpont kapcsolati erőforrás-azonosítója. |
properties |
A privát végponti kapcsolat kapcsolati állapota. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A privát végpont kapcsolati kérése befejeződött. |
|
202 Accepted |
Kérelem a privát végponti kapcsolat jóváhagyására vagy elutasítására. A hely fejléce tartalmazza azt az URL-címet, ahol a hosszú ideig futó művelet állapota ellenőrizhető. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ApiManagementApproveOrRejectPrivateEndpointConnection
Mintakérelem
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "The Private Endpoint Connection is approved."
}
}
}
Mintaválasz
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
"name": "privateEndpointConnectionName",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Succeeded",
"description": "The request has been approved."
}
}
}
Definíciók
Name | Description |
---|---|
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Private |
A privát végpont erőforrása. |
Private |
A privát végpont kapcsolati erőforrása. |
Private |
Az aktuális kiépítési állapot. |
Private |
Privát végponti kapcsolat jóváhagyására vagy elutasítására vonatkozó kérés |
Private |
A privát végpont kapcsolati állapota. |
Private |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |
Properties |
A privát végponti kapcsolat kapcsolati állapota. |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
PrivateEndpoint
A privát végpont erőforrása.
Name | Típus | Description |
---|---|---|
id |
string |
A privát végpont ARM-azonosítója |
PrivateEndpointConnection
A privát végpont kapcsolati erőforrása.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.privateEndpoint |
A privát végpont erőforrása. |
|
properties.privateLinkServiceConnectionState |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |
|
properties.provisioningState |
A privát végpont kapcsolati erőforrásának kiépítési állapota. |
|
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
Az aktuális kiépítési állapot.
Name | Típus | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointConnectionRequest
Privát végponti kapcsolat jóváhagyására vagy elutasítására vonatkozó kérés
Name | Típus | Description |
---|---|---|
id |
string |
Privát végpont kapcsolati erőforrás-azonosítója. |
properties |
A privát végponti kapcsolat kapcsolati állapota. |
PrivateEndpointServiceConnectionStatus
A privát végpont kapcsolati állapota.
Name | Típus | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
Name | Típus | Description |
---|---|---|
actionsRequired |
string |
Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére. |
description |
string |
A kapcsolat jóváhagyásának/elutasításának oka. |
status |
Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot. |
Properties
A privát végponti kapcsolat kapcsolati állapota.
Name | Típus | Description |
---|---|---|
privateLinkServiceConnectionState |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |