你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Dev Box Definitions - Update

参考

服务:: Dev Center

API 版本:: 2024-02-01

部分更新 Dev Box 定义。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
devBoxDefinitionName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Dev Box 定义的名称。
devCenterName	path	True	string minLength: 3 maxLength: 26 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$	开发中心的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
location	string	资源所在的地理位置
properties.hibernateSupport	HibernateSupport	指示使用此定义创建的 Dev Boxes 是否能够进入休眠状态。并非所有图像都能够支持休眠。若要了解详细信息，请参阅 https://aka.ms/devbox/hibernate
properties.imageReference	ImageReference	图像参考信息。
properties.osStorageType	string	用于使用此定义创建的 Dev Boxes作系统磁盘的存储类型。
properties.sku	Sku	使用此定义创建的 Dev Boxes 的 SKU。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	DevBoxDefinition	还行。请求已成功。
202 Accepted		已接受。该操作将以异步方式完成。标头 Location: string
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

名称

类型

说明

200 OK

DevBoxDefinition

还行。请求已成功。

202 Accepted

已接受。该操作将以异步方式完成。

标头

Location: string

Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

DevBoxDefinitions_Patch

示例请求

PATCH https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox?api-version=2024-02-01

{
  "properties": {
    "imageReference": {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"
    }
  }
}


import com.azure.resourcemanager.devcenter.models.DevBoxDefinition;
import com.azure.resourcemanager.devcenter.models.ImageReference;

/**
 * Samples for DevBoxDefinitions Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Patch.
     * json
     */
    /**
     * Sample code: DevBoxDefinitions_Patch.
     * 
     * @param manager Entry point to DevCenterManager.
     */
    public static void devBoxDefinitionsPatch(com.azure.resourcemanager.devcenter.DevCenterManager manager) {
        DevBoxDefinition resource = manager.devBoxDefinitions()
            .getWithResponse("rg1", "Contoso", "WebDevBox", com.azure.core.util.Context.NONE).getValue();
        resource.update().withImageReference(new ImageReference().withId(
            "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"))
            .apply();
    }
}

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.devcenter import DevCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devcenter
# USAGE
    python dev_box_definitions_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevCenterMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="0ac520ee-14c0-480f-b6c9-0a90c58ffff",
    )

    response = client.dev_box_definitions.begin_update(
        resource_group_name="rg1",
        dev_center_name="Contoso",
        dev_box_definition_name="WebDevBox",
        body={
            "properties": {
                "imageReference": {
                    "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Patch.json
if __name__ == "__main__":
    main()

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

package armdevcenter_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/devcenter/armdevcenter/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Patch.json
func ExampleDevBoxDefinitionsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevcenter.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevBoxDefinitionsClient().BeginUpdate(ctx, "rg1", "Contoso", "WebDevBox", armdevcenter.DevBoxDefinitionUpdate{
		Properties: &armdevcenter.DevBoxDefinitionUpdateProperties{
			ImageReference: &armdevcenter.ImageReference{
				ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"),
			},
		},
	}, 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 pull 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.DevBoxDefinition = armdevcenter.DevBoxDefinition{
	// 	Name: to.Ptr("WebDevBox"),
	// 	Type: to.Ptr("Microsoft.DevCenter/devcenters/devboxdefinitions"),
	// 	ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox"),
	// 	SystemData: &armdevcenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:00:36.993Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:30:36.993Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user1"),
	// 		LastModifiedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("centralus"),
	// 	Properties: &armdevcenter.DevBoxDefinitionProperties{
	// 		HibernateSupport: to.Ptr(armdevcenter.HibernateSupportEnabled),
	// 		ImageReference: &armdevcenter.ImageReference{
	// 			ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"),
	// 		},
	// 		SKU: &armdevcenter.SKU{
	// 			Name: to.Ptr("Preview"),
	// 		},
	// 		ProvisioningState: to.Ptr(armdevcenter.ProvisioningStateSucceeded),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Partially updates a Dev Box definition.
 *
 * @summary Partially updates a Dev Box definition.
 * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Patch.json
 */
async function devBoxDefinitionsPatch() {
  const subscriptionId =
    process.env["DEVCENTER_SUBSCRIPTION_ID"] || "0ac520ee-14c0-480f-b6c9-0a90c58ffff";
  const resourceGroupName = process.env["DEVCENTER_RESOURCE_GROUP"] || "rg1";
  const devCenterName = "Contoso";
  const devBoxDefinitionName = "WebDevBox";
  const body = {
    imageReference: {
      id: "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevCenterClient(credential, subscriptionId);
  const result = await client.devBoxDefinitions.beginUpdateAndWait(
    resourceGroupName,
    devCenterName,
    devBoxDefinitionName,
    body,
  );
  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

{
  "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox",
  "name": "WebDevBox",
  "type": "Microsoft.DevCenter/devcenters/devboxdefinitions",
  "properties": {
    "imageReference": {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0"
    },
    "sku": {
      "name": "Preview"
    },
    "hibernateSupport": "Enabled",
    "provisioningState": "Succeeded"
  },
  "location": "centralus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-11-18T18:00:36.993Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-11-18T18:30:36.993Z"
  }
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01

定义

名称	说明
CatalogResourceValidationStatus	目录资源验证状态
createdByType	创建资源的标识的类型。
DevBoxDefinition	表示开发人员计算机的定义。
DevBoxDefinitionUpdate	Dev Box 定义资源的部分更新。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HibernateSupport	指示是否启用/禁用休眠。
ImageReference	图像参考信息
ImageValidationErrorDetails	图像验证错误详细信息
ImageValidationStatus	图像验证状态
ProvisioningState	资源的预配状态。
Sku	表示 SKU 的资源模型定义
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
systemData	与创建和上次修改资源相关的元数据。

CatalogResourceValidationStatus

枚举

目录资源验证状态

值	说明
Failed
Pending
Succeeded
Unknown

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User