Instance Pools - Create Or Update

Dienst:: SQL Database

API-Version:: 2023-08-01

Erstellt oder aktualisiert einen Instanzpool.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instancePoolName	path	True	string	Der Name des Instanzpools, der erstellt oder aktualisiert werden soll.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Ressourcenspeicherort.
properties.licenseType	True	InstancePoolLicenseType	Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).
properties.subnetId	True	string	Ressourcen-ID des Subnetzes, in dem dieser Instanzpool platziert werden soll.
properties.vCores	True	integer (int32)	Anzahl der vCores, die zu diesem Instanzpool gehören.
properties.maintenanceConfigurationId		string (arm-id)	Gibt die Wartungskonfigurations-ID an, die auf diese verwaltete Instanz angewendet werden soll.
sku		Sku	Der Name und die Ebene der SKU.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	InstancePool	Der Instanzpool wurde erfolgreich aktualisiert.
201 Created	InstancePool	Der Instanzpool wurde erfolgreich erstellt.
202 Accepted		Angenommen Header Location: string
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 MismatchingResourceGroupNameWithUrl – Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein. 400 MismatchingSubscriptionWithUrl – Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein. 400 InvalidMinimalTlsVersion – Ungültige minimale TLS-Version. 400 InvalidResourceId – Ungültiger Ressourcenbezeichner. 400 InvalidParameterValue – Ein ungültiger Wert wurde einem Parameter zugewiesen. 400 DeleteOfManagedInstanceIsDisabled – Löschvorgang der verwalteten Instanz ist deaktiviert. 400 CustomMaintenanceWindowIsDisabled – Benutzerdefiniertes Wartungsfenster ist nicht aktiviert. 400 MICantBeMovedFromOrToInstancePool – Vorhandene verwaltete Instanz kann nicht in den Pool verwalteter Instanzen verschoben werden. 400 InvalidResourceRequestBody – Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 400 MissingSkuName – Sku-Name ist erforderlich. 400 InstancePoolRequestedVcoreCountIsInvalid – Angeforderte vcore-Anzahl für den Instanzpool ist ungültig. 400 InstancePoolRequestMissingSku – Instanzpoolanforderung fehlt sku 400 InstancePoolRequestMissingSkuTier – Instanzpoolanforderung fehlt sku-Ebene 400 InstancePoolRequestMissingSkuFamily – Instanzpoolanforderung fehlt sku-Familie 400 InstancePoolRequestedSubnetResourceIdIsInvalid - Subnetz-ID für Instanzpool ist null oder leer 400 DeploymentIntoPrivateSubnetsNotAllowed – Das Bereitstellen von verwalteten Instanzen und Instanzpools in privaten Subnetzen wird nicht unterstützt. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 409 MiCreateFailedNonDelegatedSubnet – Der Benutzer hat versucht, verwaltete Instanzen oder verwaltete Instanzen im Subnetz bereitzustellen, das nicht an Microsoft.Sql/managedInstances delegiert ist. 409 InstancePoolBusy – Ein Instanzpool ist mit einem anderen laufenden Vorgang beschäftigt. 409 MiCreateFailedNonDelegatedSubnet – Der Benutzer hat versucht, verwaltete Instanzen oder verwaltete Instanzen im Subnetz bereitzustellen, das nicht an Microsoft.Sql/managedInstances delegiert ist. 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

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=2023-08-01

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

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/stable/2023-08-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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Statuscode:: 202

Create an instance pool with min properties.

Beispielanforderung

HTTP
dotnet

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

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

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/stable/2023-08-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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Statuscode:: 202

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InstancePool	Ein Azure SQL-Instanzpool.
InstancePoolLicenseType	Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).
Sku	Eine ARM-Ressourcen-SKU.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InstancePool

Objekt

Ein Azure SQL-Instanzpool.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.dnsZone	string	Die DNS-Zone, in der sich der verwaltete Instanzpool befindet.
properties.licenseType	InstancePoolLicenseType	Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).
properties.maintenanceConfigurationId	string (arm-id)	Gibt die Wartungskonfigurations-ID an, die auf diese verwaltete Instanz angewendet werden soll.
properties.subnetId	string	Ressourcen-ID des Subnetzes, in dem dieser Instanzpool platziert werden soll.
properties.vCores	integer (int32)	Anzahl der vCores, die zu diesem Instanzpool gehören.
sku	Sku	Der Name und die Ebene der SKU.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

InstancePoolLicenseType

Enumeration

Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (Preis für SQL-Lizenz ist enthalten) und "BasePrice" (ohne SQL-Lizenzpreis).

Wert	Beschreibung
LicenseIncluded
BasePrice

Sku

Objekt

Eine ARM-Ressourcen-SKU.

Name	Typ	Beschreibung
capacity	integer (int32)	Kapazität der jeweiligen SKU.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.
size	string	Größe der jeweiligen SKU
tier	string	Die Stufe oder Edition der jeweiligen SKU, z. B. Basic, Premium.

Freigeben über

Instance Pools - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create an instance pool with all properties.

Beispielanforderung

Beispiel für eine Antwort

Create an instance pool with min properties.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstancePool

InstancePoolLicenseType

Sku