Instance Pools - Create Or Update

Servizio:: SQL Database

Versione API:: 2025-01-01

Crea o aggiorna un pool di istanze.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
instancePoolName	path	True	string	Nome del pool di istanze da recuperare.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
properties.licenseType	True	InstancePoolLicenseType	Tipo di licenza. I valori possibili sono 'LicenseIncluded' (prezzo per la licenza SQL è inclusa) e 'BasePrice' (senza prezzo di licenza SQL).
properties.subnetId	True	string	ID risorsa della subnet in cui inserire il pool di istanze.
properties.vCores	True	integer (int32)	Numero di vCore appartenenti a questo pool di istanze.
properties.maintenanceConfigurationId		string (arm-id)	Specifica l'ID di configurazione della manutenzione da applicare a questa istanza gestita.
sku		Sku	Nome e livello dello SKU.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	InstancePool	Operazione di aggiornamento 'InstancePool' della risorsa riuscita
201 Created	InstancePool	Risorsa 'InstancePool' crea operazione con successo Intestazioni Location: string Retry-After: integer
202 Accepted		Operazione sulle risorse accettata. Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create an instance pool with all properties.

Create an instance pool with min properties.

Create an instance pool with all properties.

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

{
  "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/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "a": "b"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
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/CreateOrUpdateInstancePoolMax.json
// this example is just showing the usage of "InstancePools_CreateOrUpdate" 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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstancePoolResource
InstancePoolCollection collection = resourceGroupResource.GetInstancePools();

// invoke the operation
string instancePoolName = "testIP";
InstancePoolData data = new InstancePoolData(new AzureLocation("japaneast"))
{
    Sku = new SqlSku("GP_Gen5")
    {
        Tier = "GeneralPurpose",
        Family = "Gen5",
    },
    SubnetId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1"),
    VCores = 8,
    LicenseType = InstancePoolLicenseType.LicenseIncluded,
    MaintenanceConfigurationId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1"),
    Tags =
    {
    ["a"] = "b"
    },
};
ArmOperation<InstancePoolResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, instancePoolName, data);
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

Risposta di esempio

Codice di stato:: 200

{
  "name": "testIP",
  "type": "Microsoft.Sql/instancePools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
  "location": "japaneast",
  "properties": {
    "dnsZone": "1234567890",
    "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/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "a": "b"
  }
}

Codice di stato:: 201

{
  "name": "testIP",
  "type": "Microsoft.Sql/instancePools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
  "location": "japaneast",
  "properties": {
    "dnsZone": "1234567890",
    "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/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "a": "b"
  }
}

Codice di stato:: 202

Create an instance pool with min properties.

Esempio di richiesta

HTTP
dotnet

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

{
  "location": "japaneast",
  "properties": {
    "licenseType": "LicenseIncluded",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
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/CreateOrUpdateInstancePoolMin.json
// this example is just showing the usage of "InstancePools_CreateOrUpdate" 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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstancePoolResource
InstancePoolCollection collection = resourceGroupResource.GetInstancePools();

// invoke the operation
string instancePoolName = "testIP";
InstancePoolData data = new InstancePoolData(new AzureLocation("japaneast"))
{
    Sku = new SqlSku("GP_Gen5")
    {
        Tier = "GeneralPurpose",
        Family = "Gen5",
    },
    SubnetId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1"),
    VCores = 8,
    LicenseType = InstancePoolLicenseType.LicenseIncluded,
};
ArmOperation<InstancePoolResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, instancePoolName, data);
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

Risposta di esempio

Codice di stato:: 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",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {}
}

Codice di stato:: 201

{
  "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",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {}
}

Codice di stato:: 202

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
InstancePool	Un pool di istanze Azure SQL.
InstancePoolLicenseType	Tipo di licenza. I valori possibili sono 'LicenseIncluded' (prezzo per la licenza SQL è inclusa) e 'BasePrice' (senza prezzo di licenza SQL).
Sku	SKU della risorsa ARM.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

InstancePool

Oggetto

Un pool di istanze Azure SQL.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.dnsZone	string	Zona DNS in cui si trova il pool di istanze gestite.
properties.licenseType	InstancePoolLicenseType	Tipo di licenza. I valori possibili sono 'LicenseIncluded' (prezzo per la licenza SQL è inclusa) e 'BasePrice' (senza prezzo di licenza SQL).
properties.maintenanceConfigurationId	string (arm-id)	Specifica l'ID di configurazione della manutenzione da applicare a questa istanza gestita.
properties.subnetId	string	ID risorsa della subnet in cui inserire il pool di istanze.
properties.vCores	integer (int32)	Numero di vCore appartenenti a questo pool di istanze.
sku	Sku	Nome e livello dello SKU.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

InstancePoolLicenseType

Enumerazione

Tipo di licenza. I valori possibili sono 'LicenseIncluded' (prezzo per la licenza SQL è inclusa) e 'BasePrice' (senza prezzo di licenza SQL).

Valore	Descrizione
LicenseIncluded	LicenzaInclusa
BasePrice	BasePrice

Sku

Oggetto

SKU della risorsa ARM.

Nome	Tipo	Descrizione
capacity	integer (int32)	Capacità dello SKU specifico.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.
name	string	Il nome dello SKU, in genere, una lettera + codice numerico, ad esempio P3.
size	string	Dimensioni dello SKU specifico
tier	string	Il livello o l'edizione dello SKU specifico, ad esempio Basic, Premium.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.