Private Endpoint Connections - Create Or Update

Hizmet:

Azure AI Services

API Sürümü:

2023-05-01

Bilişsel Hizmetler hesabıyla ilişkili belirtilen özel uç nokta bağlantısının durumunu güncelleştirin.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-05-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string	Bilişsel Hizmetler hesabının adı. Normal ifade deseni: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
privateEndpointConnectionName	path	True	string	Bilişsel Hizmetler Hesabı ile ilişkili özel uç nokta bağlantısının adı
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
location	string	Özel uç nokta bağlantısının konumu
properties	PrivateEndpointConnectionProperties	Kaynak özellikleri.

Yanıtlar

Name	Tür	Description
200 OK	PrivateEndpointConnection	Tamam -- Özel uç nokta bağlantı özelliklerini başarıyla güncelleştirin.
202 Accepted	PrivateEndpointConnection	İşlem başarıyla başlatıldıysa ve zaman uyumsuz olarak tamamlanacaksa HTTP 202 (Kabul Edildi).
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

PutPrivateEndpointConnection

Örnek isteği

HTTP

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"
    }
  }
}

Java

import com.azure.resourcemanager.cognitiveservices.models.PrivateEndpointConnectionProperties;
import com.azure.resourcemanager.cognitiveservices.models.PrivateEndpointServiceConnectionStatus;
import com.azure.resourcemanager.cognitiveservices.models.PrivateLinkServiceConnectionState;

/** Samples for PrivateEndpointConnections CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/PutPrivateEndpointConnection.json
     */
    /**
     * Sample code: PutPrivateEndpointConnection.
     *
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void putPrivateEndpointConnection(
        com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager
            .privateEndpointConnections()
            .define("{privateEndpointConnectionName}")
            .withExistingAccount("res7687", "sto9699")
            .withProperties(
                new PrivateEndpointConnectionProperties()
                    .withPrivateLinkServiceConnectionState(
                        new PrivateLinkServiceConnectionState()
                            .withStatus(PrivateEndpointServiceConnectionStatus.APPROVED)
                            .withDescription("Auto-Approved")))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python put_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.private_endpoint_connections.begin_create_or_update(
        resource_group_name="res7687",
        account_name="sto9699",
        private_endpoint_connection_name="{privateEndpointConnectionName}",
        properties={
            "properties": {"privateLinkServiceConnectionState": {"description": "Auto-Approved", "status": "Approved"}}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/PutPrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/PutPrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginCreateOrUpdate(ctx, "res7687", "sto9699", "{privateEndpointConnectionName}", armcognitiveservices.PrivateEndpointConnection{
		Properties: &armcognitiveservices.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armcognitiveservices.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Auto-Approved"),
				Status:      to.Ptr(armcognitiveservices.PrivateEndpointServiceConnectionStatusApproved),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armcognitiveservices.PrivateEndpointConnection{
	// 	Name: to.Ptr("{privateEndpointConnectionName}"),
	// 	Type: to.Ptr("Microsoft.CognitiveServices/accounts/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}"),
	// 	Properties: &armcognitiveservices.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armcognitiveservices.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armcognitiveservices.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Auto-Approved"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr(armcognitiveservices.PrivateEndpointServiceConnectionStatusApproved),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update the state of specified private endpoint connection associated with the Cognitive Services account.
 *
 * @summary Update the state of specified private endpoint connection associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/PutPrivateEndpointConnection.json
 */
async function putPrivateEndpointConnection() {
  const subscriptionId = process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "res7687";
  const accountName = "sto9699";
  const privateEndpointConnectionName = "{privateEndpointConnectionName}";
  const properties = {
    properties: {
      privateLinkServiceConnectionState: {
        description: "Auto-Approved",
        status: "Approved",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    privateEndpointConnectionName,
    properties
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:

200

{
  "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"
    }
  }
}

Durum kodu:

202

{
  "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"
    }
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
PrivateEndpoint	Özel Uç Nokta kaynağı.
PrivateEndpointConnection	Özel Uç Nokta Bağlantısı kaynağı.
PrivateEndpointConnectionProperties	PrivateEndpointConnectProperties özellikleri.
PrivateEndpointConnectionProvisioningState	Geçerli sağlama durumu.
PrivateEndpointServiceConnectionStatus	Özel uç nokta bağlantı durumu.
PrivateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

PrivateEndpoint

Özel Uç Nokta kaynağı.

Name	Tür	Description
id	string	Özel Uç Nokta için ARM tanımlayıcısı

PrivateEndpointConnection

Özel Uç Nokta Bağlantısı kaynağı.

Name	Tür	Description
etag	string	Kaynak Etag'i.
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Özel uç nokta bağlantısının konumu
name	string	Kaynağın adı
properties	PrivateEndpointConnectionProperties	Kaynak özellikleri.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties özellikleri.

Name	Tür	Description
groupIds	string[]	Özel bağlantı kaynak grubu kimlikleri.
privateEndpoint	PrivateEndpoint	Özel uç noktanın kaynağı.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.
provisioningState	PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantı kaynağının sağlama durumu.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

Name	Tür	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Name	Tür	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

Name	Tür	Description
actionsRequired	string	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
description	string	Bağlantının onay/reddedilme nedeni.
status	PrivateEndpointServiceConnectionStatus	Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.