Instance Pools - Update

Служба:: SQL Database

Версия API:: 2025-01-01

Обновляет пул экземпляров.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
instancePoolName	path	True	string	Имя извлекаемого пула экземпляров.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.licenseType	True	InstancePoolLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (цена на лицензию SQL включена) и BasePrice (без цены на лицензию SQL).
properties.subnetId	True	string	Идентификатор ресурса подсети для размещения этого пула экземпляров.
properties.vCores	True	integer (int32)	Количество виртуальных ядер, принадлежащих этому пулу экземпляров.
properties.maintenanceConfigurationId		string (arm-id)	Указывает идентификатор конфигурации обслуживания для применения к этому управляемому экземпляру.
sku		Sku	Имя и уровень номера SKU.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	InstancePool	Операция Azure успешно завершена.
202 Accepted		Принятый запрос на обновление ресурсов. Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

InstancePool

Операция Azure успешно завершена.

202 Accepted

Принятый запрос на обновление ресурсов.

Заголовки

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Patch an instance pool

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?api-version=2025-01-01

{
  "tags": {
    "x": "y"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/PatchInstancePool.json
// this example is just showing the usage of "InstancePools_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 InstancePoolResource created on azure
// for more information of creating InstancePoolResource, please refer to the document of InstancePoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string instancePoolName = "testIP";
ResourceIdentifier instancePoolResourceId = InstancePoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, instancePoolName);
InstancePoolResource instancePool = client.GetInstancePoolResource(instancePoolResourceId);

// invoke the operation
InstancePoolPatch patch = new InstancePoolPatch
{
    Tags =
    {
    ["x"] = "y"
    },
};
ArmOperation<InstancePoolResource> lro = await instancePool.UpdateAsync(WaitUntil.Completed, patch);
InstancePoolResource 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
InstancePoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Пример ответа

Код состояния:: 200

{
  "name": "testIP",
  "type": "Microsoft.Sql/instancePools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
  "location": "japaneast",
  "properties": {
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "x": "y"
  }
}

Код состояния:: 202

Location: https://management.azure.com/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/instancepoolazureasyncoperation/00000000-1111-2222-3333-444444444444?api-version=2022-11-01-preview

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
InstancePool	An Azure SQL instance pool.
InstancePoolLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (цена на лицензию SQL включена) и BasePrice (без цены на лицензию SQL).
InstancePoolUpdate	Обновление пула экземпляров.
Sku	SKU ресурса ARM.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

InstancePool

Объект

An Azure SQL instance pool.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.dnsZone	string	Зона Dns, в которую находится пул управляемых экземпляров.
properties.licenseType	InstancePoolLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (цена на лицензию SQL включена) и BasePrice (без цены на лицензию SQL).
properties.maintenanceConfigurationId	string (arm-id)	Указывает идентификатор конфигурации обслуживания для применения к этому управляемому экземпляру.
properties.subnetId	string	Идентификатор ресурса подсети для размещения этого пула экземпляров.
properties.vCores	integer (int32)	Количество виртуальных ядер, принадлежащих этому пулу экземпляров.
sku	Sku	Имя и уровень номера SKU.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

InstancePoolLicenseType

Перечисление

Тип лицензии. Возможные значения: LicenseIncluded (цена на лицензию SQL включена) и BasePrice (без цены на лицензию SQL).

Значение	Описание
LicenseIncluded	ЛицензияВключено
BasePrice	BasePrice

InstancePoolUpdate

Объект

Обновление пула экземпляров.

Имя	Тип	Описание
properties.dnsZone	string	Зона Dns, в которую находится пул управляемых экземпляров.
properties.licenseType	InstancePoolLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (цена на лицензию SQL включена) и BasePrice (без цены на лицензию SQL).
properties.maintenanceConfigurationId	string (arm-id)	Указывает идентификатор конфигурации обслуживания для применения к этому управляемому экземпляру.
properties.subnetId	string	Идентификатор ресурса подсети для размещения этого пула экземпляров.
properties.vCores	integer (int32)	Количество виртуальных ядер, принадлежащих этому пулу экземпляров.
sku	Sku	Имя и уровень номера SKU.
tags	object	Теги ресурсов.

Sku

Объект

SKU ресурса ARM.

Имя	Тип	Описание
capacity	integer (int32)	Емкость конкретного номера SKU.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU, как правило, буква + код номера, например P3.
size	string	Размер конкретного номера SKU
tier	string	Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.