Accounts - Create

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-10-01

Utwórz konto usług Cognitive Services. Konta to szeroki typ zasobu grupy zasobów. Przechowuje klucze dla deweloperów w celu uzyskiwania dostępu do inteligentnych interfejsów API. Jest to również typ zasobu do rozliczeń.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nazwa konta usług Cognitive Services.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
identity	Identity	Tożsamość zasobu.
kind	string	Rodzaj zasobu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
properties	AccountProperties	Właściwości konta usług Cognitive Services.
sku	Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Account	Jeśli zasób został utworzony pomyślnie lub już istniał, usługa powinna zwrócić wartość 200 (OK).
201 Created	Account	Jeśli zasób został utworzony pomyślnie, usługa powinna zwrócić 201 (OK).
202 Accepted	Account	HTTP 202 (Zaakceptowano), jeśli operacja została pomyślnie uruchomiona i zostanie ukończona asynchronicznie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się

Przykłady

Create Account

Create Account Min

Create Account

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
AbusePenalty	Kara za nadużycie.
AbusePenaltyAction	Działanie AbusePenalty.
Account	Konto usług Cognitive Services to zasób platformy Azure reprezentujący aprowizowane konto, jego typ, lokalizację i jednostkę SKU.
AccountProperties	Właściwości konta usług Cognitive Services.
ApiProperties	Właściwości interfejsu API dla specjalnych interfejsów API.
ByPassSelection	Ustawienie dla zaufanych usług.
CallRateLimit	Limit liczby wywołań konta usług Cognitive Services.
CommitmentPlanAssociation	Skojarzenie planu zobowiązania.
createdByType	Typ tożsamości, która utworzyła zasób.
Encryption	Właściwości do konfigurowania szyfrowania
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Identity	Tożsamość zasobu.
IpRule	Reguła rządząca ułatwieniami dostępu z określonego adresu IP lub zakresu adresów IP.
keySource	Wylicza możliwą wartość keySource dla szyfrowania
KeyVaultProperties	Właściwości konfigurowania właściwości usługi keyVault
MultiRegionSettings	Konto usług Cognitive Services w wielu regionach.
NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
NetworkRuleSet	Zestaw reguł zarządzających ułatwieniami dostępu do sieci.
PrivateEndpoint	Zasób prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionProperties	Właściwości właściwości PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.
ProvisioningState	Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.
PublicNetworkAccess	Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.
QuotaLimit
RaiMonitorConfig	Konfiguracja monitora Rai usług Cognitive Services.
RegionSetting	Limit liczby wywołań konta usług Cognitive Services.
RequestMatchPattern
ResourceIdentityType	Typ tożsamości.
RoutingMethods	Metody routingu w wielu regionach.
Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
SkuCapability	SkuCapability wskazuje możliwości określonej funkcji.
SkuChangeInfo	Informacje o zmianie konta w jednostce SKU.
SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
ThrottlingRule
UserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika.
UserOwnedAmlWorkspace	Obszar roboczy usługi AML należący do użytkownika dla konta usług Cognitive Services.
UserOwnedStorage	Magazyn należący do użytkownika dla konta usług Cognitive Services.
VirtualNetworkRule	Reguła rządząca ułatwieniami dostępu z określonej sieci wirtualnej.

AbusePenalty

Objekt

Kara za nadużycie.

Nazwa	Typ	Opis
action	AbusePenaltyAction	Działanie AbusePenalty.
expiration	string (date-time)	Data/godzina wygaśnięcia abusePenalty.
rateLimitPercentage	number	Procent limitu szybkości.

AbusePenaltyAction

Wyliczanie

Działanie AbusePenalty.

Wartość	Opis
Block
Throttle

Account

Objekt

Konto usług Cognitive Services to zasób platformy Azure reprezentujący aprowizowane konto, jego typ, lokalizację i jednostkę SKU.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Tożsamość zasobu.
kind	string	Rodzaj zasobu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties	AccountProperties	Właściwości konta usług Cognitive Services.
sku	Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

AccountProperties

Objekt

Właściwości konta usług Cognitive Services.

Nazwa	Typ	Opis
abusePenalty	AbusePenalty	Kara za nadużycie.
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	Właściwości obszaru roboczego AML należące do użytkownika.
apiProperties	ApiProperties	Właściwości interfejsu API dla specjalnych interfejsów API.
callRateLimit	CallRateLimit	Limit liczby wywołań konta usług Cognitive Services.
capabilities	SkuCapability[]	Pobiera możliwości konta usług Cognitive Services. Każdy element wskazuje możliwość określonej funkcji. Wartości są tylko do odczytu i do celów referencyjnych.
commitmentPlanAssociations	CommitmentPlanAssociation[]	Skojarzenia planu zobowiązania konta usług Cognitive Services.
customSubDomainName	string	Opcjonalna nazwa poddomeny używana do uwierzytelniania opartego na tokenach.
dateCreated	string	Pobiera datę utworzenia konta usług Cognitive Services.
deletionDate	string	Data usunięcia, dostępna tylko dla usuniętego konta.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	Flaga umożliwiająca dynamiczne ograniczanie przepustowości.
encryption	Encryption	Właściwości szyfrowania dla tego zasobu.
endpoint	string	Punkt końcowy utworzonego konta.
endpoints	object
internalId	string	Identyfikator wewnętrzny (przestarzały, nie używaj tej właściwości).
isMigrated	boolean	Jeśli zasób jest migrowany z istniejącego klucza.
locations	MultiRegionSettings	Ustawienia wieloregionowe konta usług Cognitive Services.
migrationToken	string	Token migracji zasobów.
networkAcls	NetworkRuleSet	Kolekcja reguł zarządzających ułatwieniami dostępu z określonych lokalizacji sieciowych.
privateEndpointConnections	PrivateEndpointConnection[]	Połączenie prywatnego punktu końcowego skojarzone z kontem usług Cognitive Services.
provisioningState	ProvisioningState	Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.
publicNetworkAccess	PublicNetworkAccess	Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Konfiguracja monitora Rai usług Cognitive Services.
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	Zaplanowana data przeczyszczania dostępna tylko dla usuniętego konta.
skuChangeInfo	SkuChangeInfo	Informacje o zmianie konta w jednostce SKU.
userOwnedStorage	UserOwnedStorage[]	Konta magazynu dla tego zasobu.

ApiProperties

Objekt

Właściwości interfejsu API dla specjalnych interfejsów API.

Nazwa	Typ	Opis
aadClientId	string maxLength: 500	(Tylko doradca metryk) Identyfikator klienta usługi Azure AD (identyfikator aplikacji).
aadTenantId	string maxLength: 500	(Tylko doradca metryk) Identyfikator dzierżawy usługi Azure AD.
eventHubConnectionString	string maxLength: 1000 pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$	(Tylko personalizacja) Flaga umożliwiająca włączenie statystyk wyszukiwania Bing.
qnaAzureSearchEndpointId	string	(Tylko QnAMaker) Identyfikator punktu końcowego usługi Azure Search usługi QnAMaker.
qnaAzureSearchEndpointKey	string	(Tylko QnAMaker) Klucz punktu końcowego usługi Azure Search usługi QnAMaker.
qnaRuntimeEndpoint	string	(Tylko QnAMaker) Punkt końcowy środowiska uruchomieniowego QnAMaker.
statisticsEnabled	boolean	(Tylko wyszukiwanie Bing) Flaga umożliwiająca włączenie statystyk wyszukiwania Bing.
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$	(Tylko personalizacja) Parametry połączenia konta magazynu.
superUser	string maxLength: 500	(Tylko doradca metryk) Superuchętny użytkownik klasyfikatora metryk.
websiteName	string maxLength: 500	(Tylko doradca metryk) Nazwa witryny internetowej klasyfikatora metryk.

ByPassSelection

Wyliczanie

Ustawienie dla zaufanych usług.

Wartość	Opis
AzureServices
None

CallRateLimit

Objekt

Limit liczby wywołań konta usług Cognitive Services.

Nazwa	Typ	Opis
count	number	Wartość licznika limitu liczby wywołań.
renewalPeriod	number	Okres odnawiania w sekundach limitu liczby wywołań.
rules	ThrottlingRule[]

CommitmentPlanAssociation

Objekt

Skojarzenie planu zobowiązania.

Nazwa	Typ	Opis
commitmentPlanId	string	Identyfikator zasobu platformy Azure planu zobowiązania.
commitmentPlanLocation	string	Lokalizacja planu zobowiązania.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

Encryption

Objekt

Właściwości do konfigurowania szyfrowania

Nazwa	Typ	Domyślna wartość	Opis
keySource	keySource	Microsoft.KeyVault	Wylicza możliwą wartość keySource dla szyfrowania
keyVaultProperties	KeyVaultProperties		Właściwości usługi KeyVault

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Identity

Objekt

Tożsamość zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości zasobu.
tenantId	string	Identyfikator dzierżawy zasobu.
type	ResourceIdentityType	Typ tożsamości.
userAssignedIdentities	<string,  UserAssignedIdentity>	Lista tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Objekt

Reguła rządząca ułatwieniami dostępu z określonego adresu IP lub zakresu adresów IP.

Nazwa	Typ	Opis
value	string	Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78).

keySource

Wyliczanie

Wylicza możliwą wartość keySource dla szyfrowania

Wartość	Opis
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Objekt

Właściwości konfigurowania właściwości usługi keyVault

Nazwa	Typ	Opis
identityClientId	string
keyName	string	Nazwa klucza z usługi KeyVault
keyVaultUri	string	Identyfikator URI usługi KeyVault
keyVersion	string	Wersja klucza z usługi KeyVault

MultiRegionSettings

Objekt

Konto usług Cognitive Services w wielu regionach.

Nazwa	Typ	Opis
regions	RegionSetting[]	Limit liczby wywołań konta usług Cognitive Services.
routingMethod	RoutingMethods	Metody routingu w wielu regionach.

NetworkRuleAction

Wyliczanie

Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.

Wartość	Opis
Allow
Deny

NetworkRuleSet

Objekt

Zestaw reguł zarządzających ułatwieniami dostępu do sieci.

Nazwa	Typ	Opis
bypass	ByPassSelection	Ustawienie dla zaufanych usług.
defaultAction	NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
ipRules	IpRule[]	Lista reguł adresów IP.
virtualNetworkRules	VirtualNetworkRule[]	Lista reguł sieci wirtualnej.

PrivateEndpoint

Objekt

Zasób prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego

PrivateEndpointConnection

Objekt

Zasób połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja połączenia prywatnego punktu końcowego
name	string	Nazwa zasobu
properties	PrivateEndpointConnectionProperties	Właściwości zasobu.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Właściwości właściwości PrivateEndpointConnectProperties.

Nazwa	Typ	Opis
groupIds	string[]	Identyfikatory grupy zasobów łącza prywatnego.
privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.
provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.

PrivateEndpointConnectionProvisioningState

Wyliczanie

Bieżący stan aprowizacji.

Wartość	Opis
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Wyliczanie

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

ProvisioningState

Wyliczanie

Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.

Wartość	Opis
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

Wyliczanie

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.

Wartość	Opis
Disabled
Enabled

QuotaLimit

Objekt

Nazwa	Typ	Opis
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Objekt

Konfiguracja monitora Rai usług Cognitive Services.

Nazwa	Typ	Opis
adxStorageResourceId	string	Identyfikator zasobu magazynu.
identityClientId	string	Identyfikator klienta tożsamości w celu uzyskania dostępu do magazynu.

RegionSetting

Objekt

Limit liczby wywołań konta usług Cognitive Services.

Nazwa	Typ	Opis
customsubdomain	string	Mapuje region na regionalną poddomenę niestandardową.
name	string	Nazwa regionu.
value	number	Wartość dla metod routingu o priorytecie lub ważonym.

RequestMatchPattern

Objekt

Nazwa	Typ	Opis
method	string
path	string

ResourceIdentityType

Wyliczanie

Typ tożsamości.

Wartość	Opis
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Wyliczanie

Metody routingu w wielu regionach.

Wartość	Opis
Performance
Priority
Weighted

Sku

Objekt

Definicja modelu zasobów reprezentująca jednostkę SKU

Nazwa	Typ	Opis
capacity	integer (int32)	Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU. Ex - P3. Zazwyczaj jest to kod z literą i cyfrą
size	string	Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod.
tier	SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

SkuCapability

Objekt

SkuCapability wskazuje możliwości określonej funkcji.

Nazwa	Typ	Opis
name	string	Nazwa klasy SkuCapability.
value	string	Wartość skuCapability.

SkuChangeInfo

Objekt

Informacje o zmianie konta w jednostce SKU.

Nazwa	Typ	Opis
countOfDowngrades	number	Pobiera liczbę obniżek.
countOfUpgradesAfterDowngrades	number	Pobiera liczbę uaktualnień po obniżeniu.
lastChangeDate	string	Pobiera ostatnią datę zmiany.

SkuTier

Wyliczanie

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

Wartość	Opis
Basic
Enterprise
Free
Premium
Standard

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

ThrottlingRule

Objekt

Nazwa	Typ	Opis
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Objekt

Tożsamość zarządzana przypisana przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator aplikacji klienckiej skojarzony z tą tożsamością.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory skojarzony z tą tożsamością.

UserOwnedAmlWorkspace

Objekt

Obszar roboczy usługi AML należący do użytkownika dla konta usług Cognitive Services.

Nazwa	Typ	Opis
identityClientId	string	Identyfikator klienta tożsamości zasobu obszaru roboczego AML.
resourceId	string	Pełny identyfikator zasobu obszaru roboczego AML.

UserOwnedStorage

Objekt

Magazyn należący do użytkownika dla konta usług Cognitive Services.

Nazwa	Typ	Opis
identityClientId	string
resourceId	string	Pełny identyfikator zasobu Microsoft.Storage.

VirtualNetworkRule

Objekt

Reguła rządząca ułatwieniami dostępu z określonej sieci wirtualnej.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Ignoruj brak punktu końcowego usługi sieci wirtualnej lub nie.
state	string	Pobiera stan reguły sieci wirtualnej.