Sql Virtual Machines - Create Or Update

サービス:: SQL VM

API バージョン:: 2023-10-01

SQL 仮想マシンを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}?api-version=2023-10-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
sqlVirtualMachineName	path	True	string minLength: 1 maxLength: 64 pattern: ^((?!_)[^\\/"'\[\]:\|<>+=;,?*@&]{1,64}(?	SQL 仮想マシンの名前。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所
identity		ResourceIdentity	使用しないでください。この値は非推奨になります。サーバーの Azure Active Directory ID。
properties.assessmentSettings		AssessmentSettings	SQL のベストプラクティスの評価の設定。
properties.autoBackupSettings		AutoBackupSettings	SQL Server の自動バックアップ設定。
properties.autoPatchingSettings		AutoPatchingSettings	SQL 仮想マシンに重要なセキュリティ更新プログラムを適用するための自動修正プログラムの設定。
properties.enableAutomaticUpgrade		boolean	Sql IaaS 拡張機能エージェントの自動アップグレードを有効にします。
properties.keyVaultCredentialSettings		KeyVaultCredentialSettings	キーコンテナーの資格情報の設定。
properties.leastPrivilegeMode		LeastPrivilegeMode	SQL IaaS Agent の最小特権モード。
properties.serverConfigurationsManagementSettings		ServerConfigurationsManagementSettings	SQL Server の構成管理設定。
properties.sqlImageOffer		string	SQL イメージオファー。例としては、SQL2016-WS2016、SQL2017-WS2016 などがあります。
properties.sqlImageSku		SqlImageSku	SQL Server エディションの種類。
properties.sqlManagement		SqlManagementMode	SQL Server 管理の種類。注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。
properties.sqlServerLicenseType		SqlServerLicenseType	SQL Server ライセンスの種類。
properties.sqlVirtualMachineGroupResourceId		string	この SQL 仮想マシンが属しているか、その一部となる SQL 仮想マシングループの ARM リソース ID。
properties.storageConfigurationSettings		StorageConfigurationSettings	ストレージ構成設定。
properties.virtualMachineIdentitySettings		VirtualMachineIdentity	Sql IaaS 拡張機能の構成に使用される仮想マシン ID の詳細。
properties.virtualMachineResourceId		string	SQL Marketplace イメージから作成された基になる仮想マシンの ARM リソース ID。
properties.wsfcDomainCredentials		WsfcDomainCredentials	SQL 可用性グループの Windows Server フェールオーバークラスターを設定するためのドメイン資格情報。
properties.wsfcStaticIp		string	SQL 可用性グループの Windows Server フェールオーバークラスターを設定するためのドメイン資格情報。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	SqlVirtualMachine	リソース 'SqlVirtualMachine' の更新操作が成功しました
201 Created	SqlVirtualMachine	リソース 'SqlVirtualMachine' の作成操作が成功しましたヘッダー Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

名前

型

説明

200 OK

SqlVirtualMachine

リソース 'SqlVirtualMachine' の更新操作が成功しました

201 Created

SqlVirtualMachine

リソース 'SqlVirtualMachine' の作成操作が成功しました

ヘッダー

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.

Creates or updates a SQL virtual machine for Automated Back up Settings with Weekly and Days of the week to run the back up.

Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.

Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.

Creates or updates a SQL virtual machine to enable the usage of Virtual Machine managed identity.

Creates or updates a SQL virtual machine with max parameters.

Creates or updates a SQL virtual machine with min parameters.

Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2",
    "wsfcDomainCredentials": {
      "clusterBootstrapAccountPassword": "<Password>",
      "clusterOperatorAccountPassword": "<Password>",
      "sqlServiceAccountPassword": "<Password>"
    },
    "wsfcStaticIp": "10.0.0.7"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateVirtualMachineWithVMGroup.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineAndJoinsItToASqlVirtualMachineGroup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			SQLVirtualMachineGroupResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup"),
			VirtualMachineResourceID:         to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2"),
			WsfcDomainCredentials: &armsqlvirtualmachine.WsfcDomainCredentials{
				ClusterBootstrapAccountPassword: to.Ptr("<Password>"),
				ClusterOperatorAccountPassword:  to.Ptr("<Password>"),
				SQLServiceAccountPassword:       to.Ptr("<Password>"),
			},
			WsfcStaticIP: to.Ptr("10.0.0.7"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm2"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(false),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			SQLVirtualMachineGroupResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup"),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2"),
	// 			WsfcStaticIP: to.Ptr("10.0.0.7"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateVirtualMachineWithVMGroup.json
 */
async function createsOrUpdatesASQLVirtualMachineAndJoinsItToASQLVirtualMachineGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    sqlVirtualMachineGroupResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup",
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2",
    wsfcDomainCredentials: {
      clusterBootstrapAccountPassword: "<Password>",
      clusterOperatorAccountPassword: "<Password>",
      sqlServiceAccountPassword: "<Password>",
    },
    wsfcStaticIp: "10.0.0.7",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm2",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": false,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2",
    "wsfcStaticIp": "10.0.0.7"
  }
}

状態コード:: 201

{
  "name": "testvm2",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2",
    "wsfcStaticIp": "10.0.0.7"
  }
}

Creates or updates a SQL virtual machine for Automated Back up Settings with Weekly and Days of the week to run the back up.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "autoBackupSettings": {
      "backupScheduleType": "Manual",
      "backupSystemDbs": true,
      "daysOfWeek": [
        "Monday",
        "Friday"
      ],
      "enable": true,
      "enableEncryption": true,
      "fullBackupFrequency": "Weekly",
      "fullBackupStartTime": 6,
      "fullBackupWindowHours": 11,
      "logBackupFrequency": 10,
      "password": "<Password>",
      "retentionPeriod": 17,
      "storageAccessKey": "<primary storage access key>",
      "storageAccountUrl": "https://teststorage.blob.core.windows.net/",
      "storageContainerName": "testcontainer"
    },
    "autoPatchingSettings": {
      "dayOfWeek": "Sunday",
      "enable": true,
      "maintenanceWindowDuration": 60,
      "maintenanceWindowStartingHour": 2
    },
    "keyVaultCredentialSettings": {
      "enable": false
    },
    "serverConfigurationsManagementSettings": {
      "additionalFeaturesServerConfigurations": {
        "isRServicesEnabled": false
      },
      "sqlConnectivityUpdateSettings": {
        "connectivityType": "PRIVATE",
        "port": 1433,
        "sqlAuthUpdatePassword": "<password>",
        "sqlAuthUpdateUserName": "sqllogin"
      },
      "sqlStorageUpdateSettings": {
        "diskConfigurationType": "NEW",
        "diskCount": 1,
        "startingDeviceId": 2
      },
      "sqlWorkloadTypeUpdateSettings": {
        "sqlWorkloadType": "OLTP"
      }
    },
    "sqlImageSku": "Enterprise",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineAutomatedBackupWeekly.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineForAutomatedBackUpSettingsWithWeeklyAndDaysOfTheWeekToRunTheBackUp() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			AutoBackupSettings: &armsqlvirtualmachine.AutoBackupSettings{
				BackupScheduleType: to.Ptr(armsqlvirtualmachine.BackupScheduleTypeManual),
				BackupSystemDbs:    to.Ptr(true),
				DaysOfWeek: []*armsqlvirtualmachine.AutoBackupDaysOfWeek{
					to.Ptr(armsqlvirtualmachine.AutoBackupDaysOfWeekMonday),
					to.Ptr(armsqlvirtualmachine.AutoBackupDaysOfWeekFriday),
				},
				Enable:                to.Ptr(true),
				EnableEncryption:      to.Ptr(true),
				FullBackupFrequency:   to.Ptr(armsqlvirtualmachine.FullBackupFrequencyTypeWeekly),
				FullBackupStartTime:   to.Ptr[int32](6),
				FullBackupWindowHours: to.Ptr[int32](11),
				LogBackupFrequency:    to.Ptr[int32](10),
				Password:              to.Ptr("<Password>"),
				RetentionPeriod:       to.Ptr[int32](17),
				StorageAccessKey:      to.Ptr("<primary storage access key>"),
				StorageAccountURL:     to.Ptr("https://teststorage.blob.core.windows.net/"),
				StorageContainerName:  to.Ptr("testcontainer"),
			},
			AutoPatchingSettings: &armsqlvirtualmachine.AutoPatchingSettings{
				DayOfWeek:                     to.Ptr(armsqlvirtualmachine.DayOfWeekSunday),
				Enable:                        to.Ptr(true),
				MaintenanceWindowDuration:     to.Ptr[int32](60),
				MaintenanceWindowStartingHour: to.Ptr[int32](2),
			},
			KeyVaultCredentialSettings: &armsqlvirtualmachine.KeyVaultCredentialSettings{
				Enable: to.Ptr(false),
			},
			ServerConfigurationsManagementSettings: &armsqlvirtualmachine.ServerConfigurationsManagementSettings{
				AdditionalFeaturesServerConfigurations: &armsqlvirtualmachine.AdditionalFeaturesServerConfigurations{
					IsRServicesEnabled: to.Ptr(false),
				},
				SQLConnectivityUpdateSettings: &armsqlvirtualmachine.SQLConnectivityUpdateSettings{
					ConnectivityType:      to.Ptr(armsqlvirtualmachine.ConnectivityTypePRIVATE),
					Port:                  to.Ptr[int32](1433),
					SQLAuthUpdatePassword: to.Ptr("<password>"),
					SQLAuthUpdateUserName: to.Ptr("sqllogin"),
				},
				SQLStorageUpdateSettings: &armsqlvirtualmachine.SQLStorageUpdateSettings{
					DiskConfigurationType: to.Ptr(armsqlvirtualmachine.DiskConfigurationTypeNEW),
					DiskCount:             to.Ptr[int32](1),
					StartingDeviceID:      to.Ptr[int32](2),
				},
				SQLWorkloadTypeUpdateSettings: &armsqlvirtualmachine.SQLWorkloadTypeUpdateSettings{
					SQLWorkloadType: to.Ptr(armsqlvirtualmachine.SQLWorkloadTypeOLTP),
				},
			},
			SQLImageSKU:              to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
			SQLServerLicenseType:     to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(false),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineAutomatedBackupWeekly.json
 */
async function createsOrUpdatesASQLVirtualMachineForAutomatedBackUpSettingsWithWeeklyAndDaysOfTheWeekToRunTheBackUp() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    autoBackupSettings: {
      backupScheduleType: "Manual",
      backupSystemDbs: true,
      daysOfWeek: ["Monday", "Friday"],
      enable: true,
      enableEncryption: true,
      fullBackupFrequency: "Weekly",
      fullBackupStartTime: 6,
      fullBackupWindowHours: 11,
      logBackupFrequency: 10,
      password: "<Password>",
      retentionPeriod: 17,
      storageAccessKey: "<primary storage access key>",
      storageAccountUrl: "https://teststorage.blob.core.windows.net/",
      storageContainerName: "testcontainer",
    },
    autoPatchingSettings: {
      dayOfWeek: "Sunday",
      enable: true,
      maintenanceWindowDuration: 60,
      maintenanceWindowStartingHour: 2,
    },
    keyVaultCredentialSettings: { enable: false },
    serverConfigurationsManagementSettings: {
      additionalFeaturesServerConfigurations: { isRServicesEnabled: false },
      sqlConnectivityUpdateSettings: {
        connectivityType: "PRIVATE",
        port: 1433,
        sqlAuthUpdatePassword: "<password>",
        sqlAuthUpdateUserName: "sqllogin",
      },
      sqlStorageUpdateSettings: { diskConfigurationType: "NEW", diskCount: 1, startingDeviceId: 2 },
      sqlWorkloadTypeUpdateSettings: { sqlWorkloadType: "OLTP" },
    },
    sqlImageSku: "Enterprise",
    sqlServerLicenseType: "PAYG",
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": false,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "storageConfigurationSettings": {
      "diskConfigurationType": "EXTEND",
      "sqlDataSettings": {
        "luns": [
          2
        ]
      }
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineStorageConfigurationEXTEND.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineForStorageConfigurationSettingsToExtendDataLogOrTempDbStoragePool() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			StorageConfigurationSettings: &armsqlvirtualmachine.StorageConfigurationSettings{
				DiskConfigurationType: to.Ptr(armsqlvirtualmachine.DiskConfigurationTypeEXTEND),
				SQLDataSettings: &armsqlvirtualmachine.SQLStorageSettings{
					Luns: []*int32{
						to.Ptr[int32](2),
					},
				},
			},
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(true),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineStorageConfigurationEXTEND.json
 */
async function createsOrUpdatesASQLVirtualMachineForStorageConfigurationSettingsToExtendDataLogOrTempDBStoragePool() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    storageConfigurationSettings: {
      diskConfigurationType: "EXTEND",
      sqlDataSettings: { luns: [2] },
    },
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "storageConfigurationSettings": {
      "diskConfigurationType": "NEW",
      "sqlDataSettings": {
        "defaultFilePath": "F:\\folderpath\\",
        "luns": [
          0
        ]
      },
      "sqlLogSettings": {
        "defaultFilePath": "G:\\folderpath\\",
        "luns": [
          1
        ]
      },
      "sqlSystemDbOnDataDisk": true,
      "sqlTempDbSettings": {
        "dataFileCount": 8,
        "dataFileSize": 256,
        "dataGrowth": 512,
        "defaultFilePath": "D:\\TEMP",
        "logFileSize": 256,
        "logGrowth": 512
      },
      "storageWorkloadType": "OLTP"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineStorageConfigurationNEW.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineForStorageConfigurationSettingsToNewDataLogAndTempDbStoragePool() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			StorageConfigurationSettings: &armsqlvirtualmachine.StorageConfigurationSettings{
				DiskConfigurationType: to.Ptr(armsqlvirtualmachine.DiskConfigurationTypeNEW),
				SQLDataSettings: &armsqlvirtualmachine.SQLStorageSettings{
					DefaultFilePath: to.Ptr("F:\\folderpath\\"),
					Luns: []*int32{
						to.Ptr[int32](0),
					},
				},
				SQLLogSettings: &armsqlvirtualmachine.SQLStorageSettings{
					DefaultFilePath: to.Ptr("G:\\folderpath\\"),
					Luns: []*int32{
						to.Ptr[int32](1),
					},
				},
				SQLSystemDbOnDataDisk: to.Ptr(true),
				SQLTempDbSettings: &armsqlvirtualmachine.SQLTempDbSettings{
					DataFileCount:   to.Ptr[int32](8),
					DataFileSize:    to.Ptr[int32](256),
					DataGrowth:      to.Ptr[int32](512),
					DefaultFilePath: to.Ptr("D:\\TEMP"),
					LogFileSize:     to.Ptr[int32](256),
					LogGrowth:       to.Ptr[int32](512),
				},
				StorageWorkloadType: to.Ptr(armsqlvirtualmachine.StorageWorkloadTypeOLTP),
			},
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(false),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineStorageConfigurationNEW.json
 */
async function createsOrUpdatesASQLVirtualMachineForStorageConfigurationSettingsToNEWDataLogAndTempDBStoragePool() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    storageConfigurationSettings: {
      diskConfigurationType: "NEW",
      sqlDataSettings: { defaultFilePath: "F:\\folderpath\\", luns: [0] },
      sqlLogSettings: { defaultFilePath: "G:\\folderpath\\", luns: [1] },
      sqlSystemDbOnDataDisk: true,
      sqlTempDbSettings: {
        dataFileCount: 8,
        dataFileSize: 256,
        dataGrowth: 512,
        defaultFilePath: "D:\\TEMP",
        logFileSize: 256,
        logGrowth: 512,
      },
      storageWorkloadType: "OLTP",
    },
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": false,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

Creates or updates a SQL virtual machine to enable the usage of Virtual Machine managed identity.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "virtualMachineIdentitySettings": {
      "type": "UserAssigned",
      "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineVmIdentitySettings.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineToEnableTheUsageOfVirtualMachineManagedIdentity() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
				Type:       to.Ptr(armsqlvirtualmachine.VMIdentityTypeUserAssigned),
				ResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity"),
			},
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(false),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeUserAssigned),
	// 				ResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity"),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineVmIdentitySettings.json
 */
async function createsOrUpdatesASQLVirtualMachineToEnableTheUsageOfVirtualMachineManagedIdentity() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    virtualMachineIdentitySettings: {
      type: "UserAssigned",
      resourceId:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity",
    },
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": false,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "UserAssigned",
      "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "UserAssigned",
      "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testvmidentity"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

Creates or updates a SQL virtual machine with max parameters.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "assessmentSettings": {
      "enable": true,
      "runImmediately": true,
      "schedule": {
        "dayOfWeek": "Sunday",
        "enable": true,
        "monthlyOccurrence": null,
        "startTime": "23:17",
        "weeklyInterval": 1
      }
    },
    "autoBackupSettings": {
      "backupScheduleType": "Manual",
      "backupSystemDbs": true,
      "enable": true,
      "enableEncryption": true,
      "fullBackupFrequency": "Daily",
      "fullBackupStartTime": 6,
      "fullBackupWindowHours": 11,
      "logBackupFrequency": 10,
      "password": "<Password>",
      "retentionPeriod": 17,
      "storageAccessKey": "<primary storage access key>",
      "storageAccountUrl": "https://teststorage.blob.core.windows.net/",
      "storageContainerName": "testcontainer"
    },
    "autoPatchingSettings": {
      "dayOfWeek": "Sunday",
      "enable": true,
      "maintenanceWindowDuration": 60,
      "maintenanceWindowStartingHour": 2
    },
    "enableAutomaticUpgrade": true,
    "keyVaultCredentialSettings": {
      "enable": false
    },
    "leastPrivilegeMode": "Enabled",
    "serverConfigurationsManagementSettings": {
      "additionalFeaturesServerConfigurations": {
        "isRServicesEnabled": false
      },
      "azureAdAuthenticationSettings": {
        "clientId": "11111111-2222-3333-4444-555555555555"
      },
      "sqlConnectivityUpdateSettings": {
        "connectivityType": "PRIVATE",
        "port": 1433,
        "sqlAuthUpdatePassword": "<password>",
        "sqlAuthUpdateUserName": "sqllogin"
      },
      "sqlInstanceSettings": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "isIfiEnabled": true,
        "isLpimEnabled": true,
        "isOptimizeForAdHocWorkloadsEnabled": true,
        "maxDop": 8,
        "maxServerMemoryMB": 128,
        "minServerMemoryMB": 0
      },
      "sqlStorageUpdateSettings": {
        "diskConfigurationType": "NEW",
        "diskCount": 1,
        "startingDeviceId": 2
      },
      "sqlWorkloadTypeUpdateSettings": {
        "sqlWorkloadType": "OLTP"
      }
    },
    "sqlImageSku": "Enterprise",
    "sqlServerLicenseType": "PAYG",
    "storageConfigurationSettings": {
      "diskConfigurationType": "NEW",
      "enableStorageConfigBlade": true,
      "sqlDataSettings": {
        "defaultFilePath": "F:\\folderpath\\",
        "luns": [
          0
        ],
        "useStoragePool": false
      },
      "sqlLogSettings": {
        "defaultFilePath": "G:\\folderpath\\",
        "luns": [
          1
        ],
        "useStoragePool": false
      },
      "sqlSystemDbOnDataDisk": true,
      "sqlTempDbSettings": {
        "dataFileCount": 8,
        "dataFileSize": 256,
        "dataGrowth": 512,
        "defaultFilePath": "D:\\TEMP",
        "logFileSize": 256,
        "logGrowth": 512,
        "luns": [
          2
        ],
        "useStoragePool": false
      },
      "storageWorkloadType": "OLTP"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineMAX.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineWithMaxParameters() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			AssessmentSettings: &armsqlvirtualmachine.AssessmentSettings{
				Enable:         to.Ptr(true),
				RunImmediately: to.Ptr(true),
				Schedule: &armsqlvirtualmachine.Schedule{
					DayOfWeek:      to.Ptr(armsqlvirtualmachine.AssessmentDayOfWeekSunday),
					Enable:         to.Ptr(true),
					StartTime:      to.Ptr("23:17"),
					WeeklyInterval: to.Ptr[int32](1),
				},
			},
			AutoBackupSettings: &armsqlvirtualmachine.AutoBackupSettings{
				BackupScheduleType:    to.Ptr(armsqlvirtualmachine.BackupScheduleTypeManual),
				BackupSystemDbs:       to.Ptr(true),
				Enable:                to.Ptr(true),
				EnableEncryption:      to.Ptr(true),
				FullBackupFrequency:   to.Ptr(armsqlvirtualmachine.FullBackupFrequencyTypeDaily),
				FullBackupStartTime:   to.Ptr[int32](6),
				FullBackupWindowHours: to.Ptr[int32](11),
				LogBackupFrequency:    to.Ptr[int32](10),
				Password:              to.Ptr("<Password>"),
				RetentionPeriod:       to.Ptr[int32](17),
				StorageAccessKey:      to.Ptr("<primary storage access key>"),
				StorageAccountURL:     to.Ptr("https://teststorage.blob.core.windows.net/"),
				StorageContainerName:  to.Ptr("testcontainer"),
			},
			AutoPatchingSettings: &armsqlvirtualmachine.AutoPatchingSettings{
				DayOfWeek:                     to.Ptr(armsqlvirtualmachine.DayOfWeekSunday),
				Enable:                        to.Ptr(true),
				MaintenanceWindowDuration:     to.Ptr[int32](60),
				MaintenanceWindowStartingHour: to.Ptr[int32](2),
			},
			EnableAutomaticUpgrade: to.Ptr(true),
			KeyVaultCredentialSettings: &armsqlvirtualmachine.KeyVaultCredentialSettings{
				Enable: to.Ptr(false),
			},
			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
			ServerConfigurationsManagementSettings: &armsqlvirtualmachine.ServerConfigurationsManagementSettings{
				AdditionalFeaturesServerConfigurations: &armsqlvirtualmachine.AdditionalFeaturesServerConfigurations{
					IsRServicesEnabled: to.Ptr(false),
				},
				AzureAdAuthenticationSettings: &armsqlvirtualmachine.AADAuthenticationSettings{
					ClientID: to.Ptr("11111111-2222-3333-4444-555555555555"),
				},
				SQLConnectivityUpdateSettings: &armsqlvirtualmachine.SQLConnectivityUpdateSettings{
					ConnectivityType:      to.Ptr(armsqlvirtualmachine.ConnectivityTypePRIVATE),
					Port:                  to.Ptr[int32](1433),
					SQLAuthUpdatePassword: to.Ptr("<password>"),
					SQLAuthUpdateUserName: to.Ptr("sqllogin"),
				},
				SQLInstanceSettings: &armsqlvirtualmachine.SQLInstanceSettings{
					Collation:                          to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
					IsIfiEnabled:                       to.Ptr(true),
					IsLpimEnabled:                      to.Ptr(true),
					IsOptimizeForAdHocWorkloadsEnabled: to.Ptr(true),
					MaxDop:                             to.Ptr[int32](8),
					MaxServerMemoryMB:                  to.Ptr[int32](128),
					MinServerMemoryMB:                  to.Ptr[int32](0),
				},
				SQLStorageUpdateSettings: &armsqlvirtualmachine.SQLStorageUpdateSettings{
					DiskConfigurationType: to.Ptr(armsqlvirtualmachine.DiskConfigurationTypeNEW),
					DiskCount:             to.Ptr[int32](1),
					StartingDeviceID:      to.Ptr[int32](2),
				},
				SQLWorkloadTypeUpdateSettings: &armsqlvirtualmachine.SQLWorkloadTypeUpdateSettings{
					SQLWorkloadType: to.Ptr(armsqlvirtualmachine.SQLWorkloadTypeOLTP),
				},
			},
			SQLImageSKU:          to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
			StorageConfigurationSettings: &armsqlvirtualmachine.StorageConfigurationSettings{
				DiskConfigurationType:    to.Ptr(armsqlvirtualmachine.DiskConfigurationTypeNEW),
				EnableStorageConfigBlade: to.Ptr(true),
				SQLDataSettings: &armsqlvirtualmachine.SQLStorageSettings{
					DefaultFilePath: to.Ptr("F:\\folderpath\\"),
					Luns: []*int32{
						to.Ptr[int32](0),
					},
					UseStoragePool: to.Ptr(false),
				},
				SQLLogSettings: &armsqlvirtualmachine.SQLStorageSettings{
					DefaultFilePath: to.Ptr("G:\\folderpath\\"),
					Luns: []*int32{
						to.Ptr[int32](1),
					},
					UseStoragePool: to.Ptr(false),
				},
				SQLSystemDbOnDataDisk: to.Ptr(true),
				SQLTempDbSettings: &armsqlvirtualmachine.SQLTempDbSettings{
					DataFileCount:   to.Ptr[int32](8),
					DataFileSize:    to.Ptr[int32](256),
					DataGrowth:      to.Ptr[int32](512),
					DefaultFilePath: to.Ptr("D:\\TEMP"),
					LogFileSize:     to.Ptr[int32](256),
					LogGrowth:       to.Ptr[int32](512),
					Luns: []*int32{
						to.Ptr[int32](2),
					},
					UseStoragePool: to.Ptr(false),
				},
				StorageWorkloadType: to.Ptr(armsqlvirtualmachine.StorageWorkloadTypeOLTP),
			},
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(true),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineMAX.json
 */
async function createsOrUpdatesASQLVirtualMachineWithMaxParameters() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    assessmentSettings: {
      enable: true,
      runImmediately: true,
      schedule: { dayOfWeek: "Sunday", enable: true, startTime: "23:17", weeklyInterval: 1 },
    },
    autoBackupSettings: {
      backupScheduleType: "Manual",
      backupSystemDbs: true,
      enable: true,
      enableEncryption: true,
      fullBackupFrequency: "Daily",
      fullBackupStartTime: 6,
      fullBackupWindowHours: 11,
      logBackupFrequency: 10,
      password: "<Password>",
      retentionPeriod: 17,
      storageAccessKey: "<primary storage access key>",
      storageAccountUrl: "https://teststorage.blob.core.windows.net/",
      storageContainerName: "testcontainer",
    },
    autoPatchingSettings: {
      dayOfWeek: "Sunday",
      enable: true,
      maintenanceWindowDuration: 60,
      maintenanceWindowStartingHour: 2,
    },
    enableAutomaticUpgrade: true,
    keyVaultCredentialSettings: { enable: false },
    leastPrivilegeMode: "Enabled",
    serverConfigurationsManagementSettings: {
      additionalFeaturesServerConfigurations: { isRServicesEnabled: false },
      azureAdAuthenticationSettings: { clientId: "11111111-2222-3333-4444-555555555555" },
      sqlConnectivityUpdateSettings: {
        connectivityType: "PRIVATE",
        port: 1433,
        sqlAuthUpdatePassword: "<password>",
        sqlAuthUpdateUserName: "sqllogin",
      },
      sqlInstanceSettings: {
        collation: "SQL_Latin1_General_CP1_CI_AS",
        isIfiEnabled: true,
        isLpimEnabled: true,
        isOptimizeForAdHocWorkloadsEnabled: true,
        maxDop: 8,
        maxServerMemoryMB: 128,
        minServerMemoryMB: 0,
      },
      sqlStorageUpdateSettings: { diskConfigurationType: "NEW", diskCount: 1, startingDeviceId: 2 },
      sqlWorkloadTypeUpdateSettings: { sqlWorkloadType: "OLTP" },
    },
    sqlImageSku: "Enterprise",
    sqlServerLicenseType: "PAYG",
    storageConfigurationSettings: {
      diskConfigurationType: "NEW",
      enableStorageConfigBlade: true,
      sqlDataSettings: { defaultFilePath: "F:\\folderpath\\", luns: [0], useStoragePool: false },
      sqlLogSettings: { defaultFilePath: "G:\\folderpath\\", luns: [1], useStoragePool: false },
      sqlSystemDbOnDataDisk: true,
      sqlTempDbSettings: {
        dataFileCount: 8,
        dataFileSize: 256,
        dataGrowth: 512,
        defaultFilePath: "D:\\TEMP",
        logFileSize: 256,
        logGrowth: 512,
        luns: [2],
        useStoragePool: false,
      },
      storageWorkloadType: "OLTP",
    },
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

Creates or updates a SQL virtual machine with min parameters.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm?api-version=2023-10-01

{
  "location": "northeurope",
  "properties": {
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

package armsqlvirtualmachine_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine"
)

// Generated from example definition: 2023-10-01/CreateOrUpdateSqlVirtualMachineMIN.json
func ExampleSQLVirtualMachinesClient_BeginCreateOrUpdate_createsOrUpdatesASqlVirtualMachineWithMinParameters() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsqlvirtualmachine.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLVirtualMachinesClient().BeginCreateOrUpdate(ctx, "testrg", "testvm", armsqlvirtualmachine.SQLVirtualMachine{
		Location: to.Ptr("northeurope"),
		Properties: &armsqlvirtualmachine.Properties{
			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsqlvirtualmachine.SQLVirtualMachinesClientCreateOrUpdateResponse{
	// 	SQLVirtualMachine: armsqlvirtualmachine.SQLVirtualMachine{
	// 		Name: to.Ptr("testvm"),
	// 		Type: to.Ptr("Microsoft.SqlVirtualMachine/sqlVirtualMachines"),
	// 		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm"),
	// 		Location: to.Ptr("northeurope"),
	// 		Properties: &armsqlvirtualmachine.Properties{
	// 			AdditionalVMPatch: to.Ptr(armsqlvirtualmachine.AdditionalOsPatchWU),
	// 			EnableAutomaticUpgrade: to.Ptr(true),
	// 			LeastPrivilegeMode: to.Ptr(armsqlvirtualmachine.LeastPrivilegeModeEnabled),
	// 			OSType: to.Ptr(armsqlvirtualmachine.OsTypeWindows),
	// 			ProvisioningState: to.Ptr("Updating"),
	// 			SQLImageOffer: to.Ptr("SQL2022-WS2022"),
	// 			SQLImageSKU: to.Ptr(armsqlvirtualmachine.SQLImageSKUEnterprise),
	// 			SQLManagement: to.Ptr(armsqlvirtualmachine.SQLManagementModeFull),
	// 			SQLServerLicenseType: to.Ptr(armsqlvirtualmachine.SQLServerLicenseTypePAYG),
	// 			VirtualMachineIdentitySettings: &armsqlvirtualmachine.VirtualMachineIdentity{
	// 				Type: to.Ptr(armsqlvirtualmachine.VMIdentityTypeSystemAssigned),
	// 			},
	// 			VirtualMachineResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a SQL virtual machine.
 *
 * @summary creates or updates a SQL virtual machine.
 * x-ms-original-file: 2023-10-01/CreateOrUpdateSqlVirtualMachineMIN.json
 */
async function createsOrUpdatesASQLVirtualMachineWithMinParameters() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlVirtualMachineManagementClient(credential, subscriptionId);
  const result = await client.sqlVirtualMachines.createOrUpdate("testrg", "testvm", {
    location: "northeurope",
    virtualMachineResourceId:
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
  });
  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

応答のサンプル

状態コード:: 200

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "additionalVmPatch": "WU",
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "Enabled",
    "osType": "Windows",
    "provisioningState": "Updating",
    "sqlImageOffer": "SQL2022-WS2022",
    "sqlImageSku": "Enterprise",
    "sqlManagement": "Full",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineIdentitySettings": {
      "type": "SystemAssigned"
    },
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

状態コード:: 201

{
  "name": "testvm",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
  "location": "northeurope",
  "properties": {
    "enableAutomaticUpgrade": true,
    "leastPrivilegeMode": "NotSet",
    "provisioningState": "Provisioning",
    "sqlImageSku": "Unknown",
    "sqlServerLicenseType": "PAYG",
    "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"
  }
}

定義

名前	説明
AADAuthenticationSettings	SQL VM の AAD 認証を有効にします。
AdditionalFeaturesServerConfigurations	その他の SQL Server 機能の設定。
AdditionalOsPatch	仮想マシンで有効になっている追加の VM 修正プログラム適用ソリューション
AdditionalVmPatch	SQL 仮想マシンで有効または有効にする追加の修正プログラム。
AssessmentDayOfWeek	評価を実行する曜日。
AssessmentSettings	SQL 仮想マシン内のデータベースの SQL ベストプラクティス評価を構成します。
AutoBackupDaysOfWeek
AutoBackupSettings	SQL 仮想マシン内のデータベースのバックアップを構成します。
AutoPatchingSettings	Windows と SQL のパッチが適用される修正プログラムの適用ウィンドウを設定します。
BackupScheduleType	バックアップスケジュールの種類。
ConnectivityType	SQL Server 接続オプション。
createdByType	リソースを作成した ID の種類。
DayOfWeek	パッチを適用する曜日。
DiskConfigurationType	SQL Server に適用するディスク構成。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FullBackupFrequencyType	完全バックアップの頻度。どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。
IdentityType	ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。
KeyVaultCredentialSettings	Azure Key Vault サービスに接続できるように SQL 仮想マシンを構成します。
LeastPrivilegeMode	SQL IaaS Agent の最小特権モード。
OsType	現在の SQL 仮想マシンのオペレーティングシステム。
ResourceIdentity	リソースの Azure Active Directory ID 構成。
Schedule	SQL Server の評価スケジュールを設定します。
ServerConfigurationsManagementSettings	接続、ストレージ、ワークロードの設定を行います。
SqlConnectivityUpdateSettings	SQL Server のアクセスレベルとネットワークポートの設定を設定します。
SqlImageSku	SQL Server エディションの種類。
SQLInstanceSettings	SQL Server のサーバー/インスタンスレベルの設定を行います。
SqlManagementMode	SQL Server 管理の種類。注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。
SqlServerLicenseType	SQL Server ライセンスの種類。
SQLStorageSettings	SQL Server のディスクストレージ設定を設定します。
SqlStorageUpdateSettings	SQL Server のディスクストレージ設定を設定します。
SQLTempDbSettings	SQL Server の tempDb ストレージ設定を設定します。
SqlVirtualMachine	SQL 仮想マシン。
SqlWorkloadType	SQL Server ワークロードの種類。
SqlWorkloadTypeUpdateSettings	SQL Server のストレージを最適化するようにワークロードの種類を設定します。
StorageConfigurationSettings	SQL データ、ログ、および TempDb のストレージ構成。
StorageWorkloadType	ストレージワークロードの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TroubleshootingAdditionalProperties	SQL VM の追加プロパティのトラブルシューティング。
TroubleshootingScenario	SQL VM のトラブルシューティングシナリオ。
TroubleshootingStatus	この SQL VM での最後のトラブルシューティング操作の状態
UnhealthyReplicaInfo	SQL VM の UnhealthyReplica シナリオ情報のトラブルシューティング。
VirtualMachineIdentity	Sql IaaS 拡張機能の構成に使用される仮想マシン ID の詳細。
VmIdentityType	仮想マシンの ID の種類。マネージド ID をオプトアウトするには、[なし] を指定します。
WsfcDomainCredentials	SQL 可用性グループの Windows Server フェールオーバークラスターを設定するためのドメイン資格情報。

AADAuthenticationSettings

Object

SQL VM の AAD 認証を有効にします。

名前	型	説明
clientId	string	Microsoft Graph API にクエリを実行するマネージド ID のクライアント ID。空の文字列は、システム割り当てマネージド ID に使用する必要があります

AdditionalFeaturesServerConfigurations

Object

その他の SQL Server 機能の設定。

名前	型	説明
isRServicesEnabled	boolean	R サービス (SQL 2016 以降) を有効または無効にします。

AdditionalOsPatch

列挙

仮想マシンで有効になっている追加の VM 修正プログラム適用ソリューション

値	説明
WU
WUMU
WSUS

AdditionalVmPatch

列挙

SQL 仮想マシンで有効または有効にする追加の修正プログラム。

値	説明
NotSet
MicrosoftUpdate

AssessmentDayOfWeek

列挙

評価を実行する曜日。

値	説明
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

AssessmentSettings

Object

SQL 仮想マシン内のデータベースの SQL ベストプラクティス評価を構成します。

名前	型	説明
enable	boolean	SQL 仮想マシンで SQL ベストプラクティス評価機能を有効または無効にします。
runImmediately	boolean	SQL 仮想マシンで SQL ベストプラクティス評価を直ちに実行します。
schedule	Schedule	SQL ベストプラクティス評価のスケジュール。

AutoBackupDaysOfWeek

列挙

値	説明
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

AutoBackupSettings

Object

SQL 仮想マシン内のデータベースのバックアップを構成します。

名前	型	説明
backupScheduleType	BackupScheduleType	バックアップスケジュールの種類。
backupSystemDbs	boolean	システムデータベースを自動バックアップに含めるか、自動バックアップから除外します。
daysOfWeek	AutoBackupDaysOfWeek[]	FullBackupFrequency が [週単位] に設定されている場合のバックアップの曜日。
enable	boolean	SQL 仮想マシンでの自動バックを有効または無効にします。
enableEncryption	boolean	SQL 仮想マシンでのバックアップの暗号化を有効または無効にします。
fullBackupFrequency	FullBackupFrequencyType	完全バックアップの頻度。どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。
fullBackupStartTime	integer (int32)	完全バックアップを実行できる特定の日の開始時刻。 0 ~ 23 時間。
fullBackupWindowHours	integer (int32)	完全バックアップを実行できる特定の日の時間枠の期間。 1 ~ 23 時間。
logBackupFrequency	integer (int32)	ログバックアップの頻度。 5 ~ 60 分。
password	string	バックアップ時の暗号化のパスワード。
retentionPeriod	integer (int32)	バックアップの保持期間: 1 ~ 90 日。
storageAccessKey	string	バックアップの保存先となるストレージアカウントキー。
storageAccountUrl	string	バックアップの保存先となるストレージアカウントの URL。
storageContainerName	string	バックアップの保存先となるストレージコンテナー名。

AutoPatchingSettings

Object

Windows と SQL のパッチが適用される修正プログラムの適用ウィンドウを設定します。

名前	型	規定値	説明
additionalVmPatch	AdditionalVmPatch	NotSet	SQL 仮想マシンで有効または有効にする追加の修正プログラム。
dayOfWeek	DayOfWeek		パッチを適用する曜日。
enable	boolean		SQL 仮想マシンで自動パッチを有効または無効にします。
maintenanceWindowDuration	integer (int32)		修正プログラムの適用期間。
maintenanceWindowStartingHour	integer (int32)		修正プログラムの適用が開始される 1 日の時間。ローカル VM 時刻。

BackupScheduleType

列挙

バックアップスケジュールの種類。

値	説明
Manual
Automated

ConnectivityType

列挙

SQL Server 接続オプション。

値	説明
LOCAL
PRIVATE
PUBLIC

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DayOfWeek

列挙

パッチを適用する曜日。

値	説明
Everyday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

DiskConfigurationType

列挙

SQL Server に適用するディスク構成。

値	説明
NEW
EXTEND
ADD

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FullBackupFrequencyType

列挙

完全バックアップの頻度。どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。

値	説明
Daily
Weekly

IdentityType

列挙

ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

値	説明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

KeyVaultCredentialSettings

Object

Azure Key Vault サービスに接続できるように SQL 仮想マシンを構成します。

名前	型	説明
azureKeyVaultUrl	string	Azure Key Vault の URL。
credentialName	string	資格情報の名前。
enable	boolean	キーコンテナーの資格情報設定を有効または無効にします。
servicePrincipalName	string	キーコンテナーにアクセスするためのサービスプリンシパル名。
servicePrincipalSecret	string	キーコンテナーにアクセスするためのサービスプリンシパル名シークレット。

LeastPrivilegeMode

列挙

SQL IaaS Agent の最小特権モード。

値	説明
Enabled
NotSet

OsType

列挙

現在の SQL 仮想マシンのオペレーティングシステム。

値	説明
Windows
Linux

ResourceIdentity

Object

リソースの Azure Active Directory ID 構成。

名前	型	説明
principalId	string (uuid)	Azure Active Directory プリンシパル ID。
tenantId	string (uuid)	Azure Active Directory テナント ID。
type	IdentityType	ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

Schedule

Object

SQL Server の評価スケジュールを設定します。

名前	型	説明
dayOfWeek	AssessmentDayOfWeek	評価を実行する曜日。
enable	boolean	SQL 仮想マシンの評価スケジュールを有効または無効にします。
monthlyOccurrence	integer (int32)	評価をスケジュールする 1 か月以内の DayOfWeek 日の発生。 1、2、3、4、-1 の値を受け取ります。月の最後の DayOfWeek 日に -1 を使用する
startTime	string	HH:mm 形式の時刻。例えば。17:30
weeklyInterval	integer (int32)	2 つの評価実行の間にスケジュールする週数。 1 から 6 の値を受け取ります

ServerConfigurationsManagementSettings

Object

接続、ストレージ、ワークロードの設定を行います。

名前	型	説明
additionalFeaturesServerConfigurations	AdditionalFeaturesServerConfigurations	その他の SQL 機能の設定。
azureAdAuthenticationSettings	AADAuthenticationSettings	Azure AD 認証の設定。
sqlConnectivityUpdateSettings	SqlConnectivityUpdateSettings	SQL 接続の種類の設定。
sqlInstanceSettings	SQLInstanceSettings	SQL インスタンスの設定。
sqlStorageUpdateSettings	SqlStorageUpdateSettings	SQL ストレージの更新設定。
sqlWorkloadTypeUpdateSettings	SqlWorkloadTypeUpdateSettings	SQL ワークロードの種類の設定。

SqlConnectivityUpdateSettings

Object

SQL Server のアクセスレベルとネットワークポートの設定を設定します。

名前	型	説明
connectivityType	ConnectivityType	SQL Server 接続オプション。
port	integer (int32)	SQL Server ポート。
sqlAuthUpdatePassword	string	SQL Server sysadmin ログインパスワード。
sqlAuthUpdateUserName	string	作成する SQL Server sysadmin ログイン。

SqlImageSku

列挙

SQL Server エディションの種類。

値	説明
Developer
Express
Standard
Enterprise
Web

SQLInstanceSettings

Object

SQL Server のサーバー/インスタンスレベルの設定を行います。

名前	型	説明
collation	string	SQL Server 照合順序。
isIfiEnabled	boolean	SQL Server IFI。
isLpimEnabled	boolean	SQL Server LPIM。
isOptimizeForAdHocWorkloadsEnabled	boolean	アドホックワークロード用の SQL Server Optimize。
maxDop	integer (int32)	SQL Server MAXDOP。
maxServerMemoryMB	integer (int32)	SQL Server の最大メモリ。
minServerMemoryMB	integer (int32)	SQL Server の最小メモリ。

SqlManagementMode

列挙

SQL Server 管理の種類。注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。

値	説明
Full
LightWeight
NoAgent

SqlServerLicenseType

列挙

SQL Server ライセンスの種類。

値	説明
PAYG
AHUB
DR

SQLStorageSettings

Object

SQL Server のディスクストレージ設定を設定します。

名前	型	説明
defaultFilePath	string	SQL Server の既定のファイルパス
luns	integer[] (int32)	ディスクの論理ユニット番号。
useStoragePool	boolean	記憶域プールを使用してドライブをビルドする (true または指定されていない場合)

SqlStorageUpdateSettings

Object

SQL Server のディスクストレージ設定を設定します。

名前	型	説明
diskConfigurationType	DiskConfigurationType	SQL Server に適用するディスク構成。
diskCount	integer (int32)	仮想マシンのディスク数。
startingDeviceId	integer (int32)	更新する最初のディスクのデバイス ID。

SQLTempDbSettings

Object

SQL Server の tempDb ストレージ設定を設定します。

名前	型	説明
dataFileCount	integer (int32)	SQL Server tempdb データファイルの数
dataFileSize	integer (int32)	SQL Server tempdb データファイルのサイズ
dataGrowth	integer (int32)	SQL Server tempdb データファイルの自動拡張サイズ
defaultFilePath	string	SQL Server の既定のファイルパス
logFileSize	integer (int32)	SQL Server tempdb ログファイルのサイズ
logGrowth	integer (int32)	SQL Server tempdb ログファイルの自動拡張サイズ
luns	integer[] (int32)	ディスクの論理ユニット番号。
persistFolder	boolean	SQL Server tempdb の保存フォルダーの選択
persistFolderPath	string	SQL Server tempdb の保存フォルダーの場所
useStoragePool	boolean	記憶域プールを使用してドライブをビルドする (true または指定されていない場合)