Accounts - Create

Dienst:

Azure AI Services

API-Version:

2024-10-01

Create Cognitive Services Account. Konten ist ein ressourcengruppenweiter Ressourcentyp. Er enthält die Schlüssel für Entwickler für den Zugriff auf intelligente APIs. Es ist auch der Ressourcentyp für die Abrechnung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Der Name des Cognitive Services-Kontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
identity	Identity	Identität für die Ressource.
kind	string	Die Art der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
properties	AccountProperties	Eigenschaften des Cognitive Services-Kontos.
sku	Sku	Die Definition des Ressourcenmodells, die SKU darstellt
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	Account	Wenn die Ressource erfolgreich erstellt wurde oder bereits vorhanden ist, sollte der Dienst 200 (OK) zurückgeben.
201 Created	Account	Wenn die Ressource erfolgreich erstellt wurde, sollte der Dienst 201 (OK) zurückgeben.
202 Accepted	Account	HTTP 202 (Akzeptiert), wenn der Vorgang erfolgreich gestartet wurde und asynchron abgeschlossen wird.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist

Beispiele

Create Account

Create Account Min

Create Account

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Statuscode:

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
AbusePenalty	Die Missbrauchsstrafe.
AbusePenaltyAction	Die Aktion von AbusePenalty.
Account	Das Cognitive Services-Konto ist eine Azure-Ressource, die das bereitgestellte Konto, den Typ, den Standort und die SKU darstellt.
AccountProperties	Eigenschaften des Cognitive Services-Kontos.
ApiProperties	Die API-Eigenschaften für spezielle APIs.
ByPassSelection	Einstellung für vertrauenswürdige Dienste.
CallRateLimit	Das Anrufratenlimit des Cognitive Services-Kontos.
CommitmentPlanAssociation	Der Verpflichtungsplanverband.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Encryption	Eigenschaften zum Konfigurieren der Verschlüsselung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource.
IpRule	Eine Regel für die Barrierefreiheit von einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich.
keySource	Listet den möglichen Wert von keySource für Verschlüsselung auf.
KeyVaultProperties	Eigenschaften zum Konfigurieren von keyVault-Eigenschaften
MultiRegionSettings	Das Multiregion Settings Cognitive Services-Konto.
NetworkRuleAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
NetworkRuleSet	Eine Reihe von Regeln für die Barrierefreiheit des Netzwerks.
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProperties	Eigenschaften der PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
ProvisioningState	Ruft den Status des Kognitiven Dienstkontos zum Zeitpunkt des Aufrufs der Operation ab.
PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist.
QuotaLimit
RaiMonitorConfig	Cognitive Services Rai Monitor Config.
RegionSetting	Das Anrufratenlimit des Cognitive Services-Kontos.
RequestMatchPattern
ResourceIdentityType	Der Identitätstyp.
RoutingMethods	Multiregion-Routingmethoden.
Sku	Die Definition des Ressourcenmodells, die SKU darstellt
SkuCapability	SkuCapability gibt die Funktion eines bestimmten Features an.
SkuChangeInfo	Sku-Änderungsinformationen des Kontos.
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
ThrottlingRule
UserAssignedIdentity	Vom Benutzer zugewiesene verwaltete Identität.
UserOwnedAmlWorkspace	Der AML-Arbeitsbereich des Benutzers für das Cognitive Services-Konto.
UserOwnedStorage	Der benutzereigene Speicher für das Cognitive Services-Konto.
VirtualNetworkRule	Eine Regel für die Barrierefreiheit aus einem bestimmten virtuellen Netzwerk.

AbusePenalty

Objekt

Die Missbrauchsstrafe.

Name	Typ	Beschreibung
action	AbusePenaltyAction	Die Aktion von AbusePenalty.
expiration	string (date-time)	Das Datum des Ablaufs der AbusePenalty.
rateLimitPercentage	number	Der Prozentsatz der Zinsgrenze.

AbusePenaltyAction

Enumeration

Die Aktion von AbusePenalty.

Wert	Beschreibung
Block
Throttle

Account

Objekt

Das Cognitive Services-Konto ist eine Azure-Ressource, die das bereitgestellte Konto, den Typ, den Standort und die SKU darstellt.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identität für die Ressource.
kind	string	Die Art der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties	AccountProperties	Eigenschaften des Cognitive Services-Kontos.
sku	Sku	Die Definition des Ressourcenmodells, die SKU darstellt
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AccountProperties

Objekt

Eigenschaften des Cognitive Services-Kontos.

Name	Typ	Beschreibung
abusePenalty	AbusePenalty	Die Missbrauchsstrafe.
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	Die AmL-Arbeitsbereichseigenschaften des Benutzers.
apiProperties	ApiProperties	Die API-Eigenschaften für spezielle APIs.
callRateLimit	CallRateLimit	Das Anrufratenlimit des Cognitive Services-Kontos.
capabilities	SkuCapability[]	Ruft die Funktionen des Cognitive Services-Kontos ab. Jedes Element gibt die Funktion eines bestimmten Features an. Die Werte sind schreibgeschützt und nur für Verweise.
commitmentPlanAssociations	CommitmentPlanAssociation[]	Die Verpflichtungsplanzuordnungen des Cognitive Services-Kontos.
customSubDomainName	string	Optionaler Unterdomänenname, der für die tokenbasierte Authentifizierung verwendet wird.
dateCreated	string	Ruft das Datum der Erstellung von kognitiven Diensten ab.
deletionDate	string	Das Löschdatum, nur für das gelöschte Konto verfügbar.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	Die Kennzeichnung zum Aktivieren der dynamischen Drosselung.
encryption	Encryption	Die Verschlüsselungseigenschaften für diese Ressource.
endpoint	string	Endpunkt des erstellten Kontos.
endpoints	object
internalId	string	Der interne Bezeichner (veraltet, verwenden Sie diese Eigenschaft nicht).
isMigrated	boolean	Wenn die Ressource aus einem vorhandenen Schlüssel migriert wird.
locations	MultiRegionSettings	Die Multiregion-Einstellungen des Cognitive Services-Kontos.
migrationToken	string	Ressourcenmigrationstoken.
networkAcls	NetworkRuleSet	Eine Sammlung von Regeln für die Barrierefreiheit von bestimmten Netzwerkstandorten.
privateEndpointConnections	PrivateEndpointConnection[]	Die private Endpunktverbindung, die mit dem Cognitive Services-Konto verknüpft ist.
provisioningState	ProvisioningState	Ruft den Status des Kognitiven Dienstkontos zum Zeitpunkt des Aufrufs der Operation ab.
publicNetworkAccess	PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist.
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Cognitive Services Rai Monitor Config.
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	Das geplante Löschdatum, das nur für gelöschte Konten verfügbar ist.
skuChangeInfo	SkuChangeInfo	Sku-Änderungsinformationen des Kontos.
userOwnedStorage	UserOwnedStorage[]	Die Speicherkonten für diese Ressource.

ApiProperties

Objekt

Die API-Eigenschaften für spezielle APIs.

Name	Typ	Beschreibung
aadClientId	string maxLength: 500	(Nur Metrikenratgeber) Die Azure AD-Client-ID (Anwendungs-ID).
aadTenantId	string maxLength: 500	(Nur Metrikenratgeber) Die Azure AD-Mandanten-ID.
eventHubConnectionString	string maxLength: 1000 pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$	(Nur Personalisierung) Das Kennzeichen zum Aktivieren von Statistiken von Bing Search.
qnaAzureSearchEndpointId	string	(Nur QnAMaker) Die Azure Search-Endpunkt-ID von QnAMaker.
qnaAzureSearchEndpointKey	string	(Nur QnAMaker) Der Azure Search-Endpunktschlüssel von QnAMaker.
qnaRuntimeEndpoint	string	(Nur QnAMaker) Der Laufzeitendpunkt von QnAMaker.
statisticsEnabled	boolean	(Nur Bing-Suche) Das Kennzeichen zum Aktivieren von Statistiken von Bing Search.
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$	(Nur Personalisierung) Die Verbindungszeichenfolge des Speicherkontos.
superUser	string maxLength: 500	(Nur Metrikenratgeber) Der Superbenutzer von Metrics Advisor.
websiteName	string maxLength: 500	(Nur Metrikenratgeber) Der Websitename von Metrics Advisor.

ByPassSelection

Enumeration

Einstellung für vertrauenswürdige Dienste.

Wert	Beschreibung
AzureServices
None

CallRateLimit

Objekt

Das Anrufratenlimit des Cognitive Services-Kontos.

Name	Typ	Beschreibung
count	number	Der Anzahlwert des Anrufratenlimits.
renewalPeriod	number	Der Verlängerungszeitraum in Sekunden des Anrufratenlimits.
rules	ThrottlingRule[]

CommitmentPlanAssociation

Objekt

Der Verpflichtungsplanverband.

Name	Typ	Beschreibung
commitmentPlanId	string	Die Azure-Ressourcen-ID des Verpflichtungsplans.
commitmentPlanLocation	string	Der Standort des Verpflichtungsplans.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Encryption

Objekt

Eigenschaften zum Konfigurieren der Verschlüsselung

Name	Typ	Standardwert	Beschreibung
keySource	keySource	Microsoft.KeyVault	Listet den möglichen Wert von keySource für Verschlüsselung auf.
keyVaultProperties	KeyVaultProperties		Eigenschaften von KeyVault

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Identity

Objekt

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität.
tenantId	string	Die Mandanten-ID der Ressource.
type	ResourceIdentityType	Der Identitätstyp.
userAssignedIdentities	<string,  UserAssignedIdentity>	Die Liste der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Objekt

Eine Regel für die Barrierefreiheit von einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich.

Name	Typ	Beschreibung
value	string	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).

keySource

Enumeration

Listet den möglichen Wert von keySource für Verschlüsselung auf.

Wert	Beschreibung
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Objekt

Eigenschaften zum Konfigurieren von keyVault-Eigenschaften

Name	Typ	Beschreibung
identityClientId	string
keyName	string	Name des Schlüssels von KeyVault
keyVaultUri	string	URI von KeyVault
keyVersion	string	Version des Schlüssels von KeyVault

MultiRegionSettings

Objekt

Das Multiregion Settings Cognitive Services-Konto.

Name	Typ	Beschreibung
regions	RegionSetting[]	Das Anrufratenlimit des Cognitive Services-Kontos.
routingMethod	RoutingMethods	Multiregion-Routingmethoden.

NetworkRuleAction

Enumeration

Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.

Wert	Beschreibung
Allow
Deny

NetworkRuleSet

Objekt

Eine Reihe von Regeln für die Barrierefreiheit des Netzwerks.

Name	Typ	Beschreibung
bypass	ByPassSelection	Einstellung für vertrauenswürdige Dienste.
defaultAction	NetworkRuleAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
ipRules	IpRule[]	Die Liste der IP-Adressregeln.
virtualNetworkRules	VirtualNetworkRule[]	Die Liste der Regeln für virtuelle Netzwerke.

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Objekt

Die Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der Speicherort der privaten Endpunktverbindung
name	string	Der Name der Ressource
properties	PrivateEndpointConnectionProperties	Ressourceneigenschaften.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Eigenschaften der PrivateEndpointConnectProperties.

Name	Typ	Beschreibung
groupIds	string[]	Die ID der privaten Verknüpfungsressourcengruppe.
privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ProvisioningState

Enumeration

Ruft den Status des Kognitiven Dienstkontos zum Zeitpunkt des Aufrufs der Operation ab.

Wert	Beschreibung
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

Enumeration

Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist.

Wert	Beschreibung
Disabled
Enabled

QuotaLimit

Objekt

Name	Typ	Beschreibung
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Objekt

Cognitive Services Rai Monitor Config.

Name	Typ	Beschreibung
adxStorageResourceId	string	Die Speicherressourcen-ID.
identityClientId	string	Die Identitätsclient-ID für den Zugriff auf den Speicher.

RegionSetting

Objekt

Das Anrufratenlimit des Cognitive Services-Kontos.

Name	Typ	Beschreibung
customsubdomain	string	Ordnet die Region der regionalen benutzerdefinierten Unterdomäne zu.
name	string	Name der Region.
value	number	Ein Wert für Prioritäts- oder Gewichtungsroutingmethoden.

RequestMatchPattern

Objekt

Name	Typ	Beschreibung
method	string
path	string

ResourceIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Enumeration

Multiregion-Routingmethoden.

Wert	Beschreibung
Performance
Priority
Weighted

Sku

Objekt

Die Definition des Ressourcenmodells, die SKU darstellt

Name	Typ	Beschreibung
capacity	integer (int32)	Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU. Ex - P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

SkuCapability

Objekt

SkuCapability gibt die Funktion eines bestimmten Features an.

Name	Typ	Beschreibung
name	string	Der Name der SkuCapability.
value	string	Der Wert der SkuCapability.

SkuChangeInfo

Objekt

Sku-Änderungsinformationen des Kontos.

Name	Typ	Beschreibung
countOfDowngrades	number	Ruft die Anzahl der Downgrades ab.
countOfUpgradesAfterDowngrades	number	Ruft die Anzahl der Upgrades nach Downgrades ab.
lastChangeDate	string	Ruft das Datum der letzten Änderung ab.

SkuTier

Enumeration

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

Wert	Beschreibung
Basic
Enterprise
Free
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

ThrottlingRule

Objekt

Name	Typ	Beschreibung
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Objekt

Vom Benutzer zugewiesene verwaltete Identität.

Name	Typ	Beschreibung
clientId	string	Dieser Identität zugeordnete Client-App-ID.
principalId	string	Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist.

UserOwnedAmlWorkspace

Objekt

Der AML-Arbeitsbereich des Benutzers für das Cognitive Services-Konto.

Name	Typ	Beschreibung
identityClientId	string	Id des Identitätsclients einer AML-Arbeitsbereichressource.
resourceId	string	Vollständige Ressourcen-ID einer AML-Arbeitsbereichsressource.

UserOwnedStorage

Objekt

Der benutzereigene Speicher für das Cognitive Services-Konto.

Name	Typ	Beschreibung
identityClientId	string
resourceId	string	Vollständige Ressourcen-ID einer Microsoft.Storage-Ressource.

VirtualNetworkRule

Objekt

Eine Regel für die Barrierefreiheit aus einem bestimmten virtuellen Netzwerk.

Name	Typ	Beschreibung
id	string	Vollständige Ressourcen-ID eines vnet-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Fehlender vnet-Dienstendpunkt ignorieren oder nicht.
state	string	Ruft den Status der virtuellen Netzwerkregel ab.