Virtual Clusters - Update

Serviço:

SQL Database

Versão da API:

2025-01-01

Atualiza um cluster virtual existente.

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
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 um UUID.
virtualClusterName	path	True	string	O nome do cluster virtual.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Descrição
properties.version	string	Versão do cluster virtual.
tags	object	Tags de recursos.

Respostas

Name	Tipo	Descrição
200 OK	VirtualCluster	Operação do Azure concluída com sucesso.
202 Accepted		Pedido de atualização de recursos aceito. 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Update virtual cluster with tags

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2?api-version=2025-01-01

{
  "tags": {
    "tkey": "tvalue1"
  }
}

Java

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

/**
 * Samples for VirtualClusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/VirtualClusterUpdate.json
     */
    /**
     * Sample code: Update virtual cluster with tags.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updateVirtualClusterWithTags(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getVirtualClusters().update("testrg", "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
            new VirtualClusterUpdate().withTags(mapOf("tkey", "fakeTokenPlaceholder")),
            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 virtual_cluster_update.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.virtual_clusters.begin_update(
        resource_group_name="testrg",
        virtual_cluster_name="vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
        parameters={"tags": {"tkey": "tvalue1"}},
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/VirtualClusterUpdate.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 existing virtual cluster.
 *
 * @summary updates an existing virtual cluster.
 * x-ms-original-file: 2025-01-01/VirtualClusterUpdate.json
 */
async function updateVirtualClusterWithTags() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.virtualClusters.update(
    "testrg",
    "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
    { tags: { tkey: "tvalue1" } },
  );
  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/VirtualClusterUpdate.json
// this example is just showing the usage of "VirtualClusters_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 VirtualClusterResource created on azure
// for more information of creating VirtualClusterResource, please refer to the document of VirtualClusterResource
string subscriptionId = "00000000-1111-2222-3333-444444444444b";
string resourceGroupName = "testrg";
string virtualClusterName = "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2";
ResourceIdentifier virtualClusterResourceId = VirtualClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualClusterName);
VirtualClusterResource virtualCluster = client.GetVirtualClusterResource(virtualClusterResourceId);

// invoke the operation
VirtualClusterPatch patch = new VirtualClusterPatch
{
    Tags =
    {
    ["tkey"] = "tvalue1"
    },
};
ArmOperation<VirtualClusterResource> lro = await virtualCluster.UpdateAsync(WaitUntil.Completed, patch);
VirtualClusterResource 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
VirtualClusterData 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 da amostra

Código de estado:

200

{
  "name": "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
  "type": "Microsoft.Sql/virtualClusters",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
  "location": "japaneast",
  "properties": {},
  "tags": {
    "tkey": "tvalue3"
  }
}

Código de estado:

202

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

Definições

Name	Descrição
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados referentes à criação e última modificação do recurso.
VirtualCluster	Um cluster virtual SQL do Azure.
VirtualClusterUpdate	Uma solicitação de atualização para cluster virtual.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

systemData

Object

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

Name	Tipo	Descrição
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.

VirtualCluster

Object

Um cluster virtual SQL do Azure.

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.childResources	string[]	Lista de recursos neste cluster virtual.
properties.subnetId	string	ID do recurso de sub-rede para o cluster virtual.
properties.version	string	Versão do cluster virtual.
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. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

VirtualClusterUpdate

Object

Uma solicitação de atualização para cluster virtual.

Name	Tipo	Descrição
properties.childResources	string[]	Lista de recursos neste cluster virtual.
properties.subnetId	string	ID do recurso de sub-rede para o cluster virtual.
properties.version	string	Versão do cluster virtual.
tags	object	Tags de recursos.