Accounts - Create

Szolgáltatás:

Azure AI Services

API-verzió:

2023-05-01

Cognitive Services-fiók létrehozása. A fiókok erőforráscsoportszintű erőforrástípusok. Ez tartalmazza az intelligens API-khoz való hozzáféréshez szükséges kulcsokat a fejlesztők számára. Ez a számlázás erőforrástípusa is.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A Cognitive Services-fiók neve. Reguláris kifejezési minta: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	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
identity	Identity	Az erőforrás identitása.
kind	string	Az erőforrás típusa.
location	string	A földrajzi hely, ahol az erőforrás él
properties	AccountProperties	A Cognitive Services-fiók tulajdonságai.
sku	Sku	A termékváltozatot képviselő erőforrásmodell-definíció
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	Account	Ha az erőforrás sikeresen létrejött vagy már létezik, a szolgáltatásnak 200 értéket (OK) kell visszaadnia.
201 Created	Account	Ha az erőforrás sikeresen létrejött, a szolgáltatásnak a 201-et (OK) kell visszaadnia.
202 Accepted	Account	HTTP 202 (Elfogadva), ha a művelet sikeresen elindult, és aszinkron módon fog befejeződni.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért hiúsult meg a művelet

Példák

Create Account

Create Account Min

Create Account

Mintakérelem

HTTP

PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2023-05-01

{
  "location": "West US",
  "kind": "Emotion",
  "sku": {
    "name": "S0"
  },
  "properties": {
    "encryption": {
      "keyVaultProperties": {
        "keyName": "KeyName",
        "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
        "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
      },
      "keySource": "Microsoft.KeyVault"
    },
    "userOwnedStorage": [
      {
        "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
      }
    ]
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Java

import com.azure.resourcemanager.cognitiveservices.models.AccountProperties;
import com.azure.resourcemanager.cognitiveservices.models.Encryption;
import com.azure.resourcemanager.cognitiveservices.models.Identity;
import com.azure.resourcemanager.cognitiveservices.models.KeySource;
import com.azure.resourcemanager.cognitiveservices.models.KeyVaultProperties;
import com.azure.resourcemanager.cognitiveservices.models.ResourceIdentityType;
import com.azure.resourcemanager.cognitiveservices.models.Sku;
import com.azure.resourcemanager.cognitiveservices.models.UserOwnedStorage;
import java.util.Arrays;

/** Samples for Accounts Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccount.json
     */
    /**
     * Sample code: Create Account.
     *
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void createAccount(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager
            .accounts()
            .define("testCreate1")
            .withExistingResourceGroup("myResourceGroup")
            .withRegion("West US")
            .withKind("Emotion")
            .withSku(new Sku().withName("S0"))
            .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED))
            .withProperties(
                new AccountProperties()
                    .withEncryption(
                        new Encryption()
                            .withKeyVaultProperties(
                                new KeyVaultProperties()
                                    .withKeyName("fakeTokenPlaceholder")
                                    .withKeyVersion("fakeTokenPlaceholder")
                                    .withKeyVaultUri("fakeTokenPlaceholder"))
                            .withKeySource(KeySource.MICROSOFT_KEY_VAULT))
                    .withUserOwnedStorage(
                        Arrays
                            .asList(
                                new UserOwnedStorage()
                                    .withResourceId(
                                        "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"))))
            .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 create_account.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="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.accounts.begin_create(
        resource_group_name="myResourceGroup",
        account_name="testCreate1",
        account={
            "identity": {"type": "SystemAssigned"},
            "kind": "Emotion",
            "location": "West US",
            "properties": {
                "encryption": {
                    "keySource": "Microsoft.KeyVault",
                    "keyVaultProperties": {
                        "keyName": "KeyName",
                        "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/",
                        "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
                    },
                },
                "userOwnedStorage": [
                    {
                        "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
                    }
                ],
            },
            "sku": {"name": "S0"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccount.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/CreateAccount.json
func ExampleAccountsClient_BeginCreate_createAccount() {
	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.NewAccountsClient().BeginCreate(ctx, "myResourceGroup", "testCreate1", armcognitiveservices.Account{
		Identity: &armcognitiveservices.Identity{
			Type: to.Ptr(armcognitiveservices.ResourceIdentityTypeSystemAssigned),
		},
		Kind:     to.Ptr("Emotion"),
		Location: to.Ptr("West US"),
		Properties: &armcognitiveservices.AccountProperties{
			Encryption: &armcognitiveservices.Encryption{
				KeySource: to.Ptr(armcognitiveservices.KeySourceMicrosoftKeyVault),
				KeyVaultProperties: &armcognitiveservices.KeyVaultProperties{
					KeyName:     to.Ptr("KeyName"),
					KeyVaultURI: to.Ptr("https://pltfrmscrts-use-pc-dev.vault.azure.net/"),
					KeyVersion:  to.Ptr("891CF236-D241-4738-9462-D506AF493DFA"),
				},
			},
			UserOwnedStorage: []*armcognitiveservices.UserOwnedStorage{
				{
					ResourceID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"),
				}},
		},
		SKU: &armcognitiveservices.SKU{
			Name: to.Ptr("S0"),
		},
	}, 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.Account = armcognitiveservices.Account{
	// 	Name: to.Ptr("testCreate1"),
	// 	Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
	// 	ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1"),
	// 	Etag: to.Ptr("W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\""),
	// 	Identity: &armcognitiveservices.Identity{
	// 		Type: to.Ptr(armcognitiveservices.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("b5cf119e-a5c2-42c7-802f-592e0efb169f"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr("Emotion"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcognitiveservices.AccountProperties{
	// 		Encryption: &armcognitiveservices.Encryption{
	// 			KeySource: to.Ptr(armcognitiveservices.KeySourceMicrosoftKeyVault),
	// 			KeyVaultProperties: &armcognitiveservices.KeyVaultProperties{
	// 				KeyName: to.Ptr("FakeKeyName"),
	// 				KeyVaultURI: to.Ptr("https://pltfrmscrts-use-pc-dev.vault.azure.net/"),
	// 				KeyVersion: to.Ptr("891CF236-D241-4738-9462-D506AF493DFA"),
	// 			},
	// 		},
	// 		Endpoint: to.Ptr("https://westus.api.cognitive.microsoft.com/emotion/v1.0"),
	// 		ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
	// 		UserOwnedStorage: []*armcognitiveservices.UserOwnedStorage{
	// 			{
	// 				ResourceID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"),
	// 		}},
	// 	},
	// 	SKU: &armcognitiveservices.SKU{
	// 		Name: to.Ptr("S0"),
	// 	},
	// }
}

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 Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
 *
 * @summary Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccount.json
 */
async function createAccount() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "myResourceGroup";
  const accountName = "testCreate1";
  const account = {
    identity: { type: "SystemAssigned" },
    kind: "Emotion",
    location: "West US",
    properties: {
      encryption: {
        keySource: "Microsoft.KeyVault",
        keyVaultProperties: {
          keyName: "KeyName",
          keyVaultUri: "https://pltfrmscrts-use-pc-dev.vault.azure.net/",
          keyVersion: "891CF236-D241-4738-9462-D506AF493DFA",
        },
      },
      userOwnedStorage: [
        {
          resourceId:
            "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
        },
      ],
    },
    sku: { name: "S0" },
  };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginCreateAndWait(resourceGroupName, accountName, account);
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CognitiveServices;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccount.json
// this example is just showing the usage of "Accounts_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this CognitiveServicesAccountResource
CognitiveServicesAccountCollection collection = resourceGroupResource.GetCognitiveServicesAccounts();

// invoke the operation
string accountName = "testCreate1";
CognitiveServicesAccountData data = new CognitiveServicesAccountData(new AzureLocation("West US"))
{
    Kind = "Emotion",
    Sku = new CognitiveServicesSku("S0"),
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Properties = new CognitiveServicesAccountProperties()
    {
        Encryption = new ServiceAccountEncryptionProperties()
        {
            KeyVaultProperties = new CognitiveServicesKeyVaultProperties()
            {
                KeyName = "KeyName",
                KeyVersion = "891CF236-D241-4738-9462-D506AF493DFA",
                KeyVaultUri = new Uri("https://pltfrmscrts-use-pc-dev.vault.azure.net/"),
            },
            KeySource = ServiceAccountEncryptionKeySource.MicrosoftKeyVault,
        },
        UserOwnedStorage =
        {
        new ServiceAccountUserOwnedStorage()
        {
        ResourceId = new ResourceIdentifier("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"),
        }
        },
    },
};
ArmOperation<CognitiveServicesAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
CognitiveServicesAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CognitiveServicesAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": {
        "keyName": "FakeKeyName",
        "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
        "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
      }
    },
    "userOwnedStorage": [
      {
        "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
      }
    ]
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Állapotkód:

201

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": {
        "keyName": "FakeKeyName",
        "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
        "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
      }
    },
    "userOwnedStorage": [
      {
        "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
      }
    ]
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Állapotkód:

202

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": {
        "keyName": "FakeKeyName",
        "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
        "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
      }
    },
    "userOwnedStorage": [
      {
        "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
      }
    ]
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Create Account Min

Mintakérelem

HTTP

PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2023-05-01

{
  "location": "West US",
  "kind": "CognitiveServices",
  "sku": {
    "name": "S0"
  },
  "properties": {},
  "identity": {
    "type": "SystemAssigned"
  }
}

Java

import com.azure.resourcemanager.cognitiveservices.models.AccountProperties;
import com.azure.resourcemanager.cognitiveservices.models.Identity;
import com.azure.resourcemanager.cognitiveservices.models.ResourceIdentityType;
import com.azure.resourcemanager.cognitiveservices.models.Sku;

/** Samples for Accounts Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccountMin.json
     */
    /**
     * Sample code: Create Account Min.
     *
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void createAccountMin(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager
            .accounts()
            .define("testCreate1")
            .withExistingResourceGroup("myResourceGroup")
            .withRegion("West US")
            .withKind("CognitiveServices")
            .withSku(new Sku().withName("S0"))
            .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED))
            .withProperties(new AccountProperties())
            .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 create_account_min.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="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.accounts.begin_create(
        resource_group_name="myResourceGroup",
        account_name="testCreate1",
        account={
            "identity": {"type": "SystemAssigned"},
            "kind": "CognitiveServices",
            "location": "West US",
            "properties": {},
            "sku": {"name": "S0"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccountMin.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/CreateAccountMin.json
func ExampleAccountsClient_BeginCreate_createAccountMin() {
	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.NewAccountsClient().BeginCreate(ctx, "myResourceGroup", "testCreate1", armcognitiveservices.Account{
		Identity: &armcognitiveservices.Identity{
			Type: to.Ptr(armcognitiveservices.ResourceIdentityTypeSystemAssigned),
		},
		Kind:       to.Ptr("CognitiveServices"),
		Location:   to.Ptr("West US"),
		Properties: &armcognitiveservices.AccountProperties{},
		SKU: &armcognitiveservices.SKU{
			Name: to.Ptr("S0"),
		},
	}, 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.Account = armcognitiveservices.Account{
	// 	Name: to.Ptr("testCreate1"),
	// 	Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
	// 	ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1"),
	// 	Etag: to.Ptr("W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\""),
	// 	Identity: &armcognitiveservices.Identity{
	// 		Type: to.Ptr(armcognitiveservices.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("b5cf119e-a5c2-42c7-802f-592e0efb169f"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr("Emotion"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcognitiveservices.AccountProperties{
	// 		Endpoint: to.Ptr("https://westus.api.cognitive.microsoft.com/emotion/v1.0"),
	// 		ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armcognitiveservices.SKU{
	// 		Name: to.Ptr("S0"),
	// 	},
	// }
}

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 Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
 *
 * @summary Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccountMin.json
 */
async function createAccountMin() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "myResourceGroup";
  const accountName = "testCreate1";
  const account = {
    identity: { type: "SystemAssigned" },
    kind: "CognitiveServices",
    location: "West US",
    properties: {},
    sku: { name: "S0" },
  };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginCreateAndWait(resourceGroupName, accountName, account);
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CognitiveServices;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/CreateAccountMin.json
// this example is just showing the usage of "Accounts_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this CognitiveServicesAccountResource
CognitiveServicesAccountCollection collection = resourceGroupResource.GetCognitiveServicesAccounts();

// invoke the operation
string accountName = "testCreate1";
CognitiveServicesAccountData data = new CognitiveServicesAccountData(new AzureLocation("West US"))
{
    Kind = "CognitiveServices",
    Sku = new CognitiveServicesSku("S0"),
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Properties = new CognitiveServicesAccountProperties(),
};
ArmOperation<CognitiveServicesAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
CognitiveServicesAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CognitiveServicesAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Állapotkód:

201

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Állapotkód:

202

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testCreate1",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "West US",
  "sku": {
    "name": "S0"
  },
  "kind": "Emotion",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Definíciók

Name	Description
AbusePenalty	A visszaélés büntetés.
AbusePenaltyAction	A AbusePenalty művelete.
Account	A Cognitive Services-fiók egy Azure-erőforrás, amely a kiépített fiókot jelöli, típusa, helye és termékváltozata.
AccountProperties	A Cognitive Services-fiók tulajdonságai.
ApiProperties	A speciális API-k API-tulajdonságai.
CallRateLimit	A hívási sebesség korlátozza a Cognitive Services-fiókot.
CommitmentPlanAssociation	A kötelezettségvállalási terv társítása.
createdByType	Az erőforrást létrehozó identitás típusa.
Encryption	A titkosítás konfigurálásához használt tulajdonságok
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Identity	Az erőforrás identitása.
IpRule	Egy adott IP-cím vagy IP-címtartomány akadálymentességét szabályozó szabály.
keySource	A keySource for Encryption lehetséges értékének számbavétele
KeyVaultProperties	Tulajdonságok a keyVault tulajdonságainak konfigurálásához
MultiRegionSettings	A többrégiós beállítások Cognitive Services-fiók.
NetworkRuleAction	Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
NetworkRuleSet	A hálózati akadálymentességet szabályozó szabályok halmaza.
PrivateEndpoint	A privát végpont erőforrása.
PrivateEndpointConnection	A privát végpont kapcsolati erőforrása.
PrivateEndpointConnectionProperties	A PrivateEndpointConnectProperties tulajdonságai.
PrivateEndpointConnectionProvisioningState	Az aktuális kiépítési állapot.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolati állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
ProvisioningState	Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában.
PublicNetworkAccess	Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a fiókhoz.
QuotaLimit
RegionSetting	A hívási sebesség korlátozza a Cognitive Services-fiókot.
RequestMatchPattern
ResourceIdentityType	Az identitás típusa.
RoutingMethods	Többrégiós útválasztási módszerek.
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuCapability	A SkuCapability egy adott funkció képességeit jelzi.
SkuChangeInfo	Termékváltozat– fiókmódosítási adatok.
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
ThrottlingRule
UserAssignedIdentity	Felhasználó által hozzárendelt felügyelt identitás.
UserOwnedStorage	A felhasználó tulajdonában lévő tárterület a Cognitive Services-fiókhoz.
VirtualNetworkRule	Egy adott virtuális hálózat akadálymentességét szabályozó szabály.

AbusePenalty

A visszaélés büntetés.

Name	Típus	Description
action	AbusePenaltyAction	A AbusePenalty művelete.
expiration	string	A AbusePenalty lejáratának dátuma.
rateLimitPercentage	number	A sebességkorlát százalékos értéke.

AbusePenaltyAction

A AbusePenalty művelete.

Name	Típus	Description
Block	string
Throttle	string

Account

A Cognitive Services-fiók egy Azure-erőforrás, amely a kiépített fiókot jelöli, típusa, helye és termékváltozata.

Name	Típus	Description
etag	string	Erőforrás-etag.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Az erőforrás identitása.
kind	string	Az erőforrás típusa.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties	AccountProperties	A Cognitive Services-fiók tulajdonságai.
sku	Sku	A termékváltozatot képviselő erőforrásmodell-definíció
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

AccountProperties

A Cognitive Services-fiók tulajdonságai.

Name	Típus	Description
abusePenalty	AbusePenalty	A visszaélés büntetése.
allowedFqdnList	string[]
apiProperties	ApiProperties	A speciális API-k API-tulajdonságai.
callRateLimit	CallRateLimit	A hívási sebesség korlátozza a Cognitive Services-fiókot.
capabilities	SkuCapability[]	Lekéri a Cognitive Services-fiók képességeit. Minden elem egy adott funkció képességeit jelzi. Az értékek írásvédettek, és csak referenciaként használhatók.
commitmentPlanAssociations	CommitmentPlanAssociation[]	A Cognitive Services-fiók kötelezettségvállalási csomagbeli társításai.
customSubDomainName	string	A tokenalapú hitelesítéshez használt nem kötelező altartománynév.
dateCreated	string	Lekéri a Cognitive Services-fiók létrehozásának dátumát.
deletionDate	string	A törlés dátuma, csak a törölt fiókhoz érhető el.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	A dinamikus szabályozás engedélyezéséhez használandó jelző.
encryption	Encryption	Az erőforrás titkosítási tulajdonságai.
endpoint	string	A létrehozott fiók végpontja.
endpoints	object
internalId	string	A belső azonosító (elavult, ne használja ezt a tulajdonságot).
isMigrated	boolean	Ha az erőforrást egy meglévő kulccsal migrálják.
locations	MultiRegionSettings	A Cognitive Services-fiók többrégiós beállításai.
migrationToken	string	Erőforrás-migrálási jogkivonat.
networkAcls	NetworkRuleSet	Az adott hálózati helyekről való akadálymentességet szabályozó szabályok gyűjteménye.
privateEndpointConnections	PrivateEndpointConnection[]	A Cognitive Services-fiókhoz társított privát végpontkapcsolat.
provisioningState	ProvisioningState	Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában.
publicNetworkAccess	PublicNetworkAccess	Azt jelzi, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a fiókhoz.
quotaLimit	QuotaLimit
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	Az ütemezett végleges törlés dátuma, amely csak a törölt fiókhoz érhető el.
skuChangeInfo	SkuChangeInfo	Termékváltozat– fiókmódosítási adatok.
userOwnedStorage	UserOwnedStorage[]	Az erőforrás tárfiókja.

ApiProperties

A speciális API-k API-tulajdonságai.

Name	Típus	Description
aadClientId	string	(Csak a Metrics Advisor esetében) A Azure AD ügyfél-azonosító (alkalmazásazonosító).
aadTenantId	string	(Csak a Metrics Advisor esetében) A Azure AD bérlőazonosítója.
eventHubConnectionString	string	(Csak személyre szabás) A Bing Search statisztikáinak engedélyezéséhez használandó jelző.
qnaAzureSearchEndpointId	string	(Csak QnAMaker esetén) A QnAMaker Azure Search-végpontazonosítója.
qnaAzureSearchEndpointKey	string	(Csak QnAMaker esetén) A QnAMaker Azure Search-végpontkulcsa.
qnaRuntimeEndpoint	string	(Csak QnAMaker esetén) A QnAMaker futtatókörnyezeti végpontja.
statisticsEnabled	boolean	(csak Bing Search) A Bing Search statisztikáinak engedélyezésére használható jelző.
storageAccountConnectionString	string	(Csak személyre szabás) A tárfiók kapcsolati karakterlánc.
superUser	string	(Csak a Metrics Advisor esetében) A Metrics Advisor felügyelője.
websiteName	string	(Csak a Metrics Advisor esetében) A Metrics Advisor webhelyneve.

CallRateLimit

A hívási sebesség korlátozza a Cognitive Services-fiókot.

Name	Típus	Description
count	number	A hívási sebesség korlátjának számértéke.
renewalPeriod	number	A megújítási időszak másodpercben a hívási sebesség korlátja után.
rules	ThrottlingRule[]

CommitmentPlanAssociation

A kötelezettségvállalási terv társítása.

Name	Típus	Description
commitmentPlanId	string	A kötelezettségvállalási csomag Azure-erőforrás-azonosítója.
commitmentPlanLocation	string	A kötelezettségvállalási terv helye.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Encryption

A titkosítás konfigurálásához használt tulajdonságok

Name	Típus	Alapértelmezett érték	Description
keySource	keySource	Microsoft.KeyVault	A keySource for Encryption lehetséges értékének számbavétele
keyVaultProperties	KeyVaultProperties		A KeyVault tulajdonságai

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Identity

Az erőforrás identitása.

Name	Típus	Description
principalId	string	Az erőforrás-identitás fő azonosítója.
tenantId	string	Az erőforrás bérlőazonosítója.
type	ResourceIdentityType	Az identitás típusa.
userAssignedIdentities	<string,  UserAssignedIdentity>	Az erőforráshoz társított felhasználó által hozzárendelt identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Egy adott IP-cím vagy IP-címtartomány akadálymentességét szabályozó szabály.

Name	Típus	Description
value	string	Egy IPv4-címtartomány CIDR-jelölésben, például "124.56.78.91" (egyszerű IP-cím) vagy "124.56.78.0/24" (minden cím, amely a 124.56.78-as számmal kezdődik).

keySource

A keySource for Encryption lehetséges értékének számbavétele

Name	Típus	Description
Microsoft.CognitiveServices	string
Microsoft.KeyVault	string

KeyVaultProperties

Tulajdonságok a keyVault tulajdonságainak konfigurálásához

Name	Típus	Description
identityClientId	string
keyName	string	A KeyVault kulcsának neve
keyVaultUri	string	A KeyVault URI-ja
keyVersion	string	A KeyVault kulcsának verziója

MultiRegionSettings

A többrégiós beállítások Cognitive Services-fiók.

Name	Típus	Description
regions	RegionSetting[]	A hívási sebesség korlátozza a Cognitive Services-fiókot.
routingMethod	RoutingMethods	Többrégiós útválasztási módszerek.

NetworkRuleAction

Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.

Name	Típus	Description
Allow	string
Deny	string

NetworkRuleSet

A hálózati akadálymentességet szabályozó szabályok halmaza.

Name	Típus	Description
defaultAction	NetworkRuleAction	Az alapértelmezett művelet, ha nincs az ipRules és a virtualNetworkRules szabálya. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
ipRules	IpRule[]	Az IP-címszabályok listája.
virtualNetworkRules	VirtualNetworkRule[]	A virtuális hálózati szabályok listája.

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
etag	string	Erőforrás-etag.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A privát végpont kapcsolatának helye
name	string	Az erőforrás neve
properties	PrivateEndpointConnectionProperties	Erőforrás tulajdonságai.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

A PrivateEndpointConnectProperties tulajdonságai.

Name	Típus	Description
groupIds	string[]	A private link erőforráscsoport-azonosítói.
privateEndpoint	PrivateEndpoint	A privát végpont erőforrása.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
provisioningState	PrivateEndpointConnectionProvisioningState	A privát végpont kapcsolati erőforrásának kiépítési állapota.

PrivateEndpointConnectionProvisioningState

Az aktuális kiépítési állapot.

Name	Típus	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

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	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

ProvisioningState

Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában.

Name	Típus	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Moving	string
ResolvingDNS	string
Succeeded	string

PublicNetworkAccess

Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a fiókhoz.

Name	Típus	Description
Disabled	string
Enabled	string

QuotaLimit

Name	Típus	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RegionSetting

A hívási sebesség korlátozza a Cognitive Services-fiókot.

Name	Típus	Description
customsubdomain	string	Leképezi a régiót a regionális egyéni altartományra.
name	string	A régió neve.
value	number	A prioritási vagy súlyozott útválasztási módszerek értéke.

RequestMatchPattern

Name	Típus	Description
method	string
path	string

ResourceIdentityType

Az identitás típusa.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RoutingMethods

Többrégiós útválasztási módszerek.

Name	Típus	Description
Performance	string
Priority	string
Weighted	string

Sku

A termékváltozatot képviselő erőforrásmodell-definíció

Name	Típus	Description
capacity	integer	Ha a termékváltozat támogatja a vertikális felskálázást/in, akkor a kapacitás egész számának szerepelnie kell. Ha az erőforrás esetében nem lehetséges a vertikális felskálázás/beskálázás, akkor ez kihagyható.
family	string	Ha a szolgáltatás különböző hardvergenerációkkal rendelkezik ugyanahhoz a termékváltozathoz, akkor az itt rögzíthető.
name	string	A termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a szint és egy másik érték kombinációja, akkor ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuCapability

A SkuCapability egy adott funkció képességeit jelzi.

Name	Típus	Description
name	string	A SkuCapability neve.
value	string	A SkuCapability értéke.

SkuChangeInfo

Termékváltozat– fiókmódosítási adatok.

Name	Típus	Description
countOfDowngrades	number	Lekéri a visszalépések számát.
countOfUpgradesAfterDowngrades	number	Lekéri a frissítések számát a visszalépések után.
lastChangeDate	string	Lekéri az utolsó módosítás dátumát.

SkuTier

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Name	Típus	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

ThrottlingRule

Name	Típus	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Felhasználó által hozzárendelt felügyelt identitás.

Name	Típus	Description
clientId	string	Az identitáshoz társított ügyfélalkalmazás-azonosító.
principalId	string	Az identitáshoz társított Azure Active Directory-egyszerű azonosító.

UserOwnedStorage

A felhasználó tulajdonában lévő tárterület a Cognitive Services-fiókhoz.

Name	Típus	Description
identityClientId	string
resourceId	string	Egy Microsoft.Storage-erőforrás teljes erőforrás-azonosítója.

VirtualNetworkRule

Egy adott virtuális hálózat akadálymentességét szabályozó szabály.

Name	Típus	Description
id	string	Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója, például "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Hagyja figyelmen kívül a hiányzó virtuális hálózati szolgáltatásvégpontot.
state	string	Lekéri a virtuális hálózati szabály állapotát.