Accounts - Update

Service:

Azure AI Services

API Version:

2024-10-01

Updates a Cognitive Services account

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of Cognitive Services account. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
identity	Identity	Identity for the resource.
kind	string	The Kind of the resource.
location	string	The geo-location where the resource lives
properties	AccountProperties	Properties of Cognitive Services account.
sku	Sku	The resource model definition representing SKU
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	Account	The resource provider should return 200 (OK) to indicate that the operation completed successfully.
202 Accepted	Account	HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.
Other Status Codes	ErrorResponse	Error response describing why the operation failed. If the resource group or resource does not exist, 404 (NotFound) should be returned.

Examples

Update Account

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch?api-version=2024-10-01

{
  "location": "global",
  "sku": {
    "name": "S2"
  }
}

Java

import com.azure.resourcemanager.cognitiveservices.models.Account;
import com.azure.resourcemanager.cognitiveservices.models.Sku;

/**
 * Samples for Accounts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * UpdateAccount.json
     */
    /**
     * Sample code: Update Account.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void updateAccount(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        Account resource = manager.accounts()
            .getByResourceGroupWithResponse("bvttest", "bingSearch", com.azure.core.util.Context.NONE).getValue();
        resource.update().withSku(new Sku().withName("S2")).apply();
    }
}

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.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json
// this example is just showing the usage of "Accounts_Update" 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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "bvttest";
string accountName = "bingSearch";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// invoke the operation
CognitiveServicesAccountData data = new CognitiveServicesAccountData(new AzureLocation("global"))
{
    Sku = new CognitiveServicesSku("S2"),
};
ArmOperation<CognitiveServicesAccountResource> lro = await cognitiveServicesAccount.UpdateAsync(WaitUntil.Completed, 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

Sample response

Status code:

200

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
AbusePenalty	The abuse penalty.
AbusePenaltyAction	The action of AbusePenalty.
Account	Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
AccountProperties	Properties of Cognitive Services account.
ApiProperties	The api properties for special APIs.
ByPassSelection	Setting for trusted services.
CallRateLimit	The call rate limit Cognitive Services account.
CommitmentPlanAssociation	The commitment plan association.
createdByType	The type of identity that created the resource.
Encryption	Properties to configure Encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Identity	Identity for the resource.
IpRule	A rule governing the accessibility from a specific ip address or ip range.
keySource	Enumerates the possible value of keySource for Encryption
KeyVaultProperties	Properties to configure keyVault Properties
MultiRegionSettings	The multiregion settings Cognitive Services account.
NetworkRuleAction	The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
NetworkRuleSet	A set of rules governing the network accessibility.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProperties	Properties of the PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisioningState	Gets the status of the cognitive services account at the time the operation was called.
PublicNetworkAccess	Whether or not public endpoint access is allowed for this account.
QuotaLimit
RaiMonitorConfig	Cognitive Services Rai Monitor Config.
RegionSetting	The call rate limit Cognitive Services account.
RequestMatchPattern
ResourceIdentityType	The identity type.
RoutingMethods	Multiregion routing methods.
Sku	The resource model definition representing SKU
SkuCapability	SkuCapability indicates the capability of a certain feature.
SkuChangeInfo	Sku change info of account.
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.
ThrottlingRule
UserAssignedIdentity	User-assigned managed identity.
UserOwnedAmlWorkspace	The user owned AML workspace for Cognitive Services account.
UserOwnedStorage	The user owned storage for Cognitive Services account.
VirtualNetworkRule	A rule governing the accessibility from a specific virtual network.

AbusePenalty

The abuse penalty.

Name	Type	Description
action	AbusePenaltyAction	The action of AbusePenalty.
expiration	string	The datetime of expiration of the AbusePenalty.
rateLimitPercentage	number	The percentage of rate limit.

AbusePenaltyAction

The action of AbusePenalty.

Name	Type	Description
Block	string
Throttle	string

Account

Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identity for the resource.
kind	string	The Kind of the resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	AccountProperties	Properties of Cognitive Services account.
sku	Sku	The resource model definition representing SKU
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AccountProperties

Properties of Cognitive Services account.

Name	Type	Description
abusePenalty	AbusePenalty	The abuse penalty.
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	The user owned AML workspace properties.
apiProperties	ApiProperties	The api properties for special APIs.
callRateLimit	CallRateLimit	The call rate limit Cognitive Services account.
capabilities	SkuCapability[]	Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.
commitmentPlanAssociations	CommitmentPlanAssociation[]	The commitment plan associations of Cognitive Services account.
customSubDomainName	string	Optional subdomain name used for token-based authentication.
dateCreated	string	Gets the date of cognitive services account creation.
deletionDate	string	The deletion date, only available for deleted account.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	The flag to enable dynamic throttling.
encryption	Encryption	The encryption properties for this resource.
endpoint	string	Endpoint of the created account.
endpoints	object
internalId	string	The internal identifier (deprecated, do not use this property).
isMigrated	boolean	If the resource is migrated from an existing key.
locations	MultiRegionSettings	The multiregion settings of Cognitive Services account.
migrationToken	string	Resource migration token.
networkAcls	NetworkRuleSet	A collection of rules governing the accessibility from specific network locations.
privateEndpointConnections	PrivateEndpointConnection[]	The private endpoint connection associated with the Cognitive Services account.
provisioningState	ProvisioningState	Gets the status of the cognitive services account at the time the operation was called.
publicNetworkAccess	PublicNetworkAccess	Whether or not public endpoint access is allowed for this account.
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Cognitive Services Rai Monitor Config.
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	The scheduled purge date, only available for deleted account.
skuChangeInfo	SkuChangeInfo	Sku change info of account.
userOwnedStorage	UserOwnedStorage[]	The storage accounts for this resource.

ApiProperties

The api properties for special APIs.

Name	Type	Description
aadClientId	string	(Metrics Advisor Only) The Azure AD Client Id (Application Id).
aadTenantId	string	(Metrics Advisor Only) The Azure AD Tenant Id.
eventHubConnectionString	string	(Personalization Only) The flag to enable statistics of Bing Search.
qnaAzureSearchEndpointId	string	(QnAMaker Only) The Azure Search endpoint id of QnAMaker.
qnaAzureSearchEndpointKey	string	(QnAMaker Only) The Azure Search endpoint key of QnAMaker.
qnaRuntimeEndpoint	string	(QnAMaker Only) The runtime endpoint of QnAMaker.
statisticsEnabled	boolean	(Bing Search Only) The flag to enable statistics of Bing Search.
storageAccountConnectionString	string	(Personalization Only) The storage account connection string.
superUser	string	(Metrics Advisor Only) The super user of Metrics Advisor.
websiteName	string	(Metrics Advisor Only) The website name of Metrics Advisor.

ByPassSelection

Setting for trusted services.

Name	Type	Description
AzureServices	string
None	string

CallRateLimit

The call rate limit Cognitive Services account.

Name	Type	Description
count	number	The count value of Call Rate Limit.
renewalPeriod	number	The renewal period in seconds of Call Rate Limit.
rules	ThrottlingRule[]

CommitmentPlanAssociation

The commitment plan association.

Name	Type	Description
commitmentPlanId	string	The Azure resource id of the commitment plan.
commitmentPlanLocation	string	The location of of the commitment plan.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Encryption

Properties to configure Encryption

Name	Type	Default value	Description
keySource	keySource	Microsoft.KeyVault	Enumerates the possible value of keySource for Encryption
keyVaultProperties	KeyVaultProperties		Properties of KeyVault

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Identity

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.
userAssignedIdentities	<string,  UserAssignedIdentity>	The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

A rule governing the accessibility from a specific ip address or ip range.

Name	Type	Description
value	string	An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).

keySource

Enumerates the possible value of keySource for Encryption

Name	Type	Description
Microsoft.CognitiveServices	string
Microsoft.KeyVault	string

KeyVaultProperties

Properties to configure keyVault Properties

Name	Type	Description
identityClientId	string
keyName	string	Name of the Key from KeyVault
keyVaultUri	string	Uri of KeyVault
keyVersion	string	Version of the Key from KeyVault

MultiRegionSettings

The multiregion settings Cognitive Services account.

Name	Type	Description
regions	RegionSetting[]	The call rate limit Cognitive Services account.
routingMethod	RoutingMethods	Multiregion routing methods.

NetworkRuleAction

The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.

Name	Type	Description
Allow	string
Deny	string

NetworkRuleSet

A set of rules governing the network accessibility.

Name	Type	Description
bypass	ByPassSelection	Setting for trusted services.
defaultAction	NetworkRuleAction	The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
ipRules	IpRule[]	The list of IP address rules.
virtualNetworkRules	VirtualNetworkRule[]	The list of virtual network rules.

PrivateEndpoint

The Private Endpoint resource.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint

PrivateEndpointConnection

The Private Endpoint Connection resource.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The location of the private endpoint connection
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Resource properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Properties of the PrivateEndpointConnectProperties.

Name	Type	Description
groupIds	string[]	The private link resource group ids.
privateEndpoint	PrivateEndpoint	The resource of private end point.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Gets the status of the cognitive services account at the time the operation was called.

Name	Type	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Moving	string
ResolvingDNS	string
Succeeded	string

PublicNetworkAccess

Whether or not public endpoint access is allowed for this account.

Name	Type	Description
Disabled	string
Enabled	string

QuotaLimit

Name	Type	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Cognitive Services Rai Monitor Config.

Name	Type	Description
adxStorageResourceId	string	The storage resource Id.
identityClientId	string	The identity client Id to access the storage.

RegionSetting

The call rate limit Cognitive Services account.

Name	Type	Description
customsubdomain	string	Maps the region to the regional custom subdomain.
name	string	Name of the region.
value	number	A value for priority or weighted routing methods.

RequestMatchPattern

Name	Type	Description
method	string
path	string

ResourceIdentityType

The identity type.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RoutingMethods

Multiregion routing methods.

Name	Type	Description
Performance	string
Priority	string
Weighted	string

Sku

The resource model definition representing SKU

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuCapability

SkuCapability indicates the capability of a certain feature.

Name	Type	Description
name	string	The name of the SkuCapability.
value	string	The value of the SkuCapability.

SkuChangeInfo

Sku change info of account.

Name	Type	Description
countOfDowngrades	number	Gets the count of downgrades.
countOfUpgradesAfterDowngrades	number	Gets the count of upgrades after downgrades.
lastChangeDate	string	Gets the last change date.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name	Type	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

ThrottlingRule

Name	Type	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

User-assigned managed identity.

Name	Type	Description
clientId	string	Client App Id associated with this identity.
principalId	string	Azure Active Directory principal ID associated with this Identity.

UserOwnedAmlWorkspace

The user owned AML workspace for Cognitive Services account.

Name	Type	Description
identityClientId	string	Identity Client id of a AML workspace resource.
resourceId	string	Full resource id of a AML workspace resource.

UserOwnedStorage

The user owned storage for Cognitive Services account.

Name	Type	Description
identityClientId	string
resourceId	string	Full resource id of a Microsoft.Storage resource.

VirtualNetworkRule

A rule governing the accessibility from a specific virtual network.

Name	Type	Description
id	string	Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
ignoreMissingVnetServiceEndpoint	boolean	Ignore missing vnet service endpoint or not.
state	string	Gets the state of virtual network rule.