Accounts - Create

服務:

Azure AI Services

API 版本:

2024-10-01

建立認知服務帳戶。 帳戶是整個資源群組的資源類型。 它會保存開發人員存取智慧型 API 的金鑰。 這也是計費的資源類型。

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	認知服務帳戶的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
identity	Identity	資源的身分識別。
kind	string	資源的Kind。
location	string	資源所在的地理位置
properties	AccountProperties	認知服務帳戶的屬性。
sku	Sku	代表 SKU 的資源模型定義
tags	object	資源標籤。

回應

名稱	類型	Description
200 OK	Account	如果資源已成功建立或已存在，服務應該會傳回 200 （確定）。
201 Created	Account	如果成功建立資源，服務應該會傳回 201 （確定）。
202 Accepted	Account	如果作業已成功啟動，且會以異步方式完成，則 HTTP 202 （已接受）。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應

範例

Create Account

Create Account Min

Create Account

範例要求

HTTP

PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2024-10-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/2024-10-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/2024-10-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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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/2024-10-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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

範例回覆

狀態碼:

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

狀態碼:

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

狀態碼:

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

範例要求

HTTP

PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2024-10-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/2024-10-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/2024-10-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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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/2024-10-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-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

範例回覆

狀態碼:

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

狀態碼:

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

狀態碼:

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

定義

名稱	Description
AbusePenalty	濫用處罰。
AbusePenaltyAction	AbusePenalty 的行動。
Account	認知服務帳戶是代表已布建帳戶的 Azure 資源，其類型、位置和 SKU。
AccountProperties	認知服務帳戶的屬性。
ApiProperties	特殊 API 的 API 屬性。
ByPassSelection	設定信任的服務。
CallRateLimit	通話速率限制認知服務帳戶。
CommitmentPlanAssociation	承諾方案關聯。
createdByType	建立資源的身分識別類型。
Encryption	設定加密的屬性
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Identity	資源的身分識別。
IpRule	從特定IP位址或ip範圍控管輔助功能的規則。
keySource	列舉 Encryption 的 keySource 可能值
KeyVaultProperties	設定keyVault屬性的屬性
MultiRegionSettings	多區域設定認知服務帳戶。
NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。
NetworkRuleSet	一組管理網路輔助功能的規則。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnection	私人端點聯機資源。
PrivateEndpointConnectionProperties	PrivateEndpointConnectProperties 的屬性。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
ProvisioningState	取得呼叫作業時認知服務帳戶的狀態。
PublicNetworkAccess	此帳戶是否允許公用端點存取。
QuotaLimit
RaiMonitorConfig	認知服務 Rai 監視器設定。
RegionSetting	通話速率限制認知服務帳戶。
RequestMatchPattern
ResourceIdentityType	識別類型。
RoutingMethods	多重區域路由方法。
Sku	代表 SKU 的資源模型定義
SkuCapability	SkuCapability 表示特定功能的功能。
SkuChangeInfo	帳戶的 Sku 變更資訊。
SkuTier	如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。
systemData	與建立和上次修改資源相關的元數據。
ThrottlingRule
UserAssignedIdentity	使用者指派的受控識別。
UserOwnedAmlWorkspace	用戶擁有認知服務帳戶的 AML 工作區。
UserOwnedStorage	認知服務帳戶的用戶擁有記憶體。
VirtualNetworkRule	從特定虛擬網路控管輔助功能的規則。

AbusePenalty

Object

濫用處罰。

名稱	類型	Description
action	AbusePenaltyAction	AbusePenalty 的行動。
expiration	string (date-time)	AbusePenalty 到期的日期時間。
rateLimitPercentage	number	速率限制的百分比。

AbusePenaltyAction

列舉型別

AbusePenalty 的行動。

值	Description
Block
Throttle

Account

Object

認知服務帳戶是代表已布建帳戶的 Azure 資源，其類型、位置和 SKU。

名稱	類型	Description
etag	string	資源 Etag。
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	資源的身分識別。
kind	string	資源的Kind。
location	string	資源所在的地理位置
name	string	資源的名稱
properties	AccountProperties	認知服務帳戶的屬性。
sku	Sku	代表 SKU 的資源模型定義
systemData	systemData	與建立和上次修改資源相關的元數據。
tags	object	資源標籤。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

AccountProperties

Object

認知服務帳戶的屬性。

名稱	類型	Description
abusePenalty	AbusePenalty	濫用處罰。
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	用戶擁有 AML 工作區屬性。
apiProperties	ApiProperties	特殊 API 的 API 屬性。
callRateLimit	CallRateLimit	通話速率限制認知服務帳戶。
capabilities	SkuCapability[]	取得認知服務帳戶的功能。 每個項目都會指出特定功能的功能。 這些值是只讀的，僅供參考。
commitmentPlanAssociations	CommitmentPlanAssociation[]	認知服務帳戶的承諾方案關聯。
customSubDomainName	string	用於令牌型驗證的選擇性子域名稱。
dateCreated	string	取得認知服務帳戶建立的日期。
deletionDate	string	刪除日期，僅適用於已刪除的帳戶。
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	啟用動態節流的旗標。
encryption	Encryption	此資源的加密屬性。
endpoint	string	已建立帳戶的端點。
endpoints	object
internalId	string	內部標識碼（已被取代，請勿使用這個屬性）。
isMigrated	boolean	如果資源是從現有的金鑰移轉的。
locations	MultiRegionSettings	認知服務帳戶的多重區域設定。
migrationToken	string	資源移轉令牌。
networkAcls	NetworkRuleSet	管理來自特定網路位置之輔助功能的規則集合。
privateEndpointConnections	PrivateEndpointConnection[]	與認知服務帳戶相關聯的私人端點連線。
provisioningState	ProvisioningState	取得呼叫作業時認知服務帳戶的狀態。
publicNetworkAccess	PublicNetworkAccess	此帳戶是否允許公用端點存取。
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	認知服務 Rai 監視器設定。
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	排程的清除日期，僅適用於已刪除的帳戶。
skuChangeInfo	SkuChangeInfo	帳戶的 Sku 變更資訊。
userOwnedStorage	UserOwnedStorage[]	此資源的記憶體帳戶。

ApiProperties

Object

特殊 API 的 API 屬性。

名稱	類型	Description
aadClientId	string maxLength: 500	（僅限計量建議程式）Azure AD 用戶端識別碼（應用程式識別符）。
aadTenantId	string maxLength: 500	（僅限計量建議程式）Azure AD 租用戶標識碼。
eventHubConnectionString	string maxLength: 1000 pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$	（僅限個人化）啟用 Bing 搜尋統計數據的旗標。
qnaAzureSearchEndpointId	string	（僅限 QnAMaker）QnAMaker 的 Azure 搜尋服務端點標識碼。
qnaAzureSearchEndpointKey	string	（僅限 QnAMaker）QnAMaker 的 Azure 搜尋服務端點密鑰。
qnaRuntimeEndpoint	string	（僅限 QnAMaker）QnAMaker 的運行時間端點。
statisticsEnabled	boolean	（僅限 Bing 搜尋）啟用 Bing 搜尋統計數據的旗標。
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$	（僅限個人化）記憶體帳戶連接字串。
superUser	string maxLength: 500	（僅限計量建議程式）Metrics Advisor 的進階使用者。
websiteName	string maxLength: 500	（僅限計量建議程式）Metrics Advisor 的網站名稱。

ByPassSelection

列舉型別

設定信任的服務。

值	Description
AzureServices
None

CallRateLimit

Object

通話速率限制認知服務帳戶。

名稱	類型	Description
count	number	通話速率限制的計數值。
renewalPeriod	number	通話速率限制秒數的更新期間。
rules	ThrottlingRule[]

CommitmentPlanAssociation

Object

承諾方案關聯。

名稱	類型	Description
commitmentPlanId	string	承諾用量方案的 Azure 資源識別碼。
commitmentPlanLocation	string	承諾方案的位置。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

Encryption

Object

設定加密的屬性

名稱	類型	預設值	Description
keySource	keySource	Microsoft.KeyVault	列舉 Encryption 的 keySource 可能值
keyVaultProperties	KeyVaultProperties		KeyVault 的屬性

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Identity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	ResourceIdentityType	識別類型。
userAssignedIdentities	<string,  UserAssignedIdentity>	與資源相關聯的使用者指派身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Object

從特定IP位址或ip範圍控管輔助功能的規則。

名稱	類型	Description
value	string	CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' （簡單 IP 位址） 或 '124.56.78.0/24' （開頭為 124.56.78 的所有位址）。

keySource

列舉型別

列舉 Encryption 的 keySource 可能值

值	Description
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Object

設定keyVault屬性的屬性

名稱	類型	Description
identityClientId	string
keyName	string	KeyVault 中的金鑰名稱
keyVaultUri	string	KeyVault 的 URI
keyVersion	string	KeyVault 中的金鑰版本

MultiRegionSettings

Object

多區域設定認知服務帳戶。

名稱	類型	Description
regions	RegionSetting[]	通話速率限制認知服務帳戶。
routingMethod	RoutingMethods	多重區域路由方法。

NetworkRuleAction

列舉型別

沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。

值	Description
Allow
Deny

NetworkRuleSet

Object

一組管理網路輔助功能的規則。

名稱	類型	Description
bypass	ByPassSelection	設定信任的服務。
defaultAction	NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。
ipRules	IpRule[]	IP 位址規則的清單。
virtualNetworkRules	VirtualNetworkRule[]	虛擬網路規則的清單。

PrivateEndpoint

Object

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼

PrivateEndpointConnection

Object

私人端點聯機資源。

名稱	類型	Description
etag	string	資源 Etag。
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	私人端點連線的位置
name	string	資源的名稱
properties	PrivateEndpointConnectionProperties	資源屬性。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

Object

PrivateEndpointConnectProperties 的屬性。

名稱	類型	Description
groupIds	string[]	私人鏈接資源群組識別碼。
privateEndpoint	PrivateEndpoint	私人端點的資源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機資源的布建狀態。

PrivateEndpointConnectionProvisioningState

列舉型別

目前的布建狀態。

值	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列舉型別

私人端點連線狀態。

值	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

ProvisioningState

列舉型別

取得呼叫作業時認知服務帳戶的狀態。

值	Description
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

列舉型別

此帳戶是否允許公用端點存取。

值	Description
Disabled
Enabled

QuotaLimit

Object

名稱	類型	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Object

認知服務 Rai 監視器設定。

名稱	類型	Description
adxStorageResourceId	string	記憶體資源標識碼。
identityClientId	string	用來存取記憶體的身分識別用戶端標識碼。

RegionSetting

Object

通話速率限制認知服務帳戶。

名稱	類型	Description
customsubdomain	string	將區域對應至區域自定義子域。
name	string	區域的名稱。
value	number	優先順序或加權路由方法的值。

RequestMatchPattern

Object

名稱	類型	Description
method	string
path	string

ResourceIdentityType

列舉型別

識別類型。

值	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

列舉型別

多重區域路由方法。

值	Description
Performance
Priority
Weighted

Sku

Object

代表 SKU 的資源模型定義

名稱	類型	Description
capacity	integer (int32)	如果 SKU 支援相應放大/縮小，則應該包含容量整數。 如果資源無法相應放大/縮小，可能會省略此專案。
family	string	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱。 例如 - P3。 通常是字母+數位碼
size	string	SKU 大小。 當名稱欄位是階層和其他一些值的組合時，這會是獨立程序代碼。
tier	SkuTier	如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

SkuCapability

Object

SkuCapability 表示特定功能的功能。

名稱	類型	Description
name	string	SkuCapability 的名稱。
value	string	SkuCapability 的值。

SkuChangeInfo

Object

帳戶的 Sku 變更資訊。

名稱	類型	Description
countOfDowngrades	number	取得降級計數。
countOfUpgradesAfterDowngrades	number	取得降級后的升級計數。
lastChangeDate	string	取得上次變更日期。

SkuTier

列舉型別

如果服務有一個以上的層級，但 PUT 上不需要此欄位，則資源提供者必須實作此字段。

值	Description
Basic
Enterprise
Free
Premium
Standard

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

ThrottlingRule

Object

名稱	類型	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Object

使用者指派的受控識別。

名稱	類型	Description
clientId	string	與此身分識別相關聯的用戶端應用程式標識碼。
principalId	string	與此身分識別相關聯的 Azure Active Directory 主體標識符。

UserOwnedAmlWorkspace

Object

用戶擁有認知服務帳戶的 AML 工作區。

名稱	類型	Description
identityClientId	string	身分識別 AML 工作區資源的用戶端標識碼。
resourceId	string	AML 工作區資源的完整資源標識碼。

UserOwnedStorage

Object

認知服務帳戶的用戶擁有記憶體。

名稱	類型	Description
identityClientId	string
resourceId	string	Microsoft.Storage 資源的完整資源標識符。

VirtualNetworkRule

Object

從特定虛擬網路控管輔助功能的規則。

名稱	類型	Description
id	string	vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。
ignoreMissingVnetServiceEndpoint	boolean	忽略遺漏的 vnet 服務端點。
state	string	取得虛擬網路規則的狀態。