Instance Pools - Update

Serviço:

SQL Database

Versão da API:

2025-01-01

Atualiza um pool de instâncias.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instancePoolName	path	True	string	O nome do pool de instâncias a ser recuperado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.licenseType	True	InstancePoolLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (o preço da licença SQL está incluído) e "BasePrice" (sem o preço da licença SQL).
properties.subnetId	True	string	ID do recurso da sub-rede na qual colocar esse pool de instâncias.
properties.vCores	True	integer (int32)	Contagem de vCores que pertencem a esse pool de instâncias.
properties.maintenanceConfigurationId		string (arm-id)	Especifica a ID de configuração de manutenção a ser aplicada a essa instância gerenciada.
sku		Sku	O nome e a camada do SKU.
tags		object	Tags de recursos.

Respostas

Nome	Tipo	Description
200 OK	InstancePool	Operação do Azure concluída com sucesso.
202 Accepted		Solicitação de atualização de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Patch an instance pool

Solicitação de exemplo

HTTP

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

Java

import com.azure.resourcemanager.sql.models.InstancePoolUpdate;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for InstancePools Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/PatchInstancePool.json
     */
    /**
     * Sample code: Patch an instance pool.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void patchAnInstancePool(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getInstancePools().update("group1", "testIP",
            new InstancePoolUpdate().withTags(mapOf("x", "y")), com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python patch_instance_pool.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.instance_pools.begin_update(
        resource_group_name="group1",
        instance_pool_name="testIP",
        parameters={"tags": {"x": "y"}},
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/PatchInstancePool.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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates an instance pool.
 *
 * @summary updates an instance pool.
 * x-ms-original-file: 2025-01-01/PatchInstancePool.json
 */
async function patchAnInstancePool() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.instancePools.update("group1", "testIP", { tags: { x: "y" } });
  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.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

Resposta de exemplo

Código de status:

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

Código de status:

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

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
InstancePool	Um pool de instâncias SQL do Azure.
InstancePoolLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (o preço da licença SQL está incluído) e "BasePrice" (sem o preço da licença SQL).
InstancePoolUpdate	Uma atualização para um pool de instâncias.
Sku	Um SKU de recurso do ARM.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

InstancePool

Objeto

Um pool de instâncias SQL do Azure.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.dnsZone	string	A Zona Dns em que o pool de instância gerenciada está.
properties.licenseType	InstancePoolLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (o preço da licença SQL está incluído) e "BasePrice" (sem o preço da licença SQL).
properties.maintenanceConfigurationId	string (arm-id)	Especifica a ID de configuração de manutenção a ser aplicada a essa instância gerenciada.
properties.subnetId	string	ID do recurso da sub-rede na qual colocar esse pool de instâncias.
properties.vCores	integer (int32)	Contagem de vCores que pertencem a esse pool de instâncias.
sku	Sku	O nome e a camada do SKU.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

InstancePoolLicenseType

Enumeração

O tipo de licença. Os valores possíveis são "LicenseIncluded" (o preço da licença SQL está incluído) e "BasePrice" (sem o preço da licença SQL).

Valor	Description
LicenseIncluded	LicençaIncluído
BasePrice	BasePrice

InstancePoolUpdate

Objeto

Uma atualização para um pool de instâncias.

Nome	Tipo	Description
properties.dnsZone	string	A Zona Dns em que o pool de instância gerenciada está.
properties.licenseType	InstancePoolLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (o preço da licença SQL está incluído) e "BasePrice" (sem o preço da licença SQL).
properties.maintenanceConfigurationId	string (arm-id)	Especifica a ID de configuração de manutenção a ser aplicada a essa instância gerenciada.
properties.subnetId	string	ID do recurso da sub-rede na qual colocar esse pool de instâncias.
properties.vCores	integer (int32)	Contagem de vCores que pertencem a esse pool de instâncias.
sku	Sku	O nome e a camada do SKU.
tags	object	Tags de recursos.

Sku

Objeto

Um SKU de recurso do ARM.

Nome	Tipo	Description
capacity	integer (int32)	Capacidade da SKU específica.
family	string	Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.
name	string	O nome da SKU, normalmente, uma letra + código de número, por exemplo, P3.
size	string	Tamanho da SKU específica
tier	string	A camada ou edição da SKU específica, por exemplo, Basic, Premium.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.