Resource Groups - Create Or Update

Service:

Resource Management

API Version:

2021-04-01

建立或更新資源群組。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}?api-version=2021-04-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	要建立或更新之資源組名。 可以包含英數位元、底線、括號、連字元、句號 (，但結尾) 除外，以及符合允許字元的 Unicode 字元。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源群組的位置。 建立資源群組之後無法變更它。 它必須是其中一個支援的 Azure 位置。
managedBy		string	管理此資源群組之資源的標識碼。
properties		ResourceGroupProperties	資源群組屬性。
tags		object	附加至資源群組的標記。

回應

名稱	類型	Description
200 OK	ResourceGroup	確定 - 傳回新資源群組的相關信息。
201 Created	ResourceGroup	已建立 - 傳回新資源群組的相關信息。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create or update a resource group

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group?api-version=2021-04-01

{
  "location": "eastus"
}

Go

package armresources_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/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/CreateResourceGroup.json
func ExampleResourceGroupsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceGroupsClient().CreateOrUpdate(ctx, "my-resource-group", armresources.ResourceGroup{
		Location: to.Ptr("eastus"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.ResourceGroup = armresources.ResourceGroup{
	// 	Name: to.Ptr("my-resource-group"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armresources.ResourceGroupProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates a resource group.
 *
 * @summary Creates or updates a resource group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/CreateResourceGroup.json
 */
async function createOrUpdateAResourceGroup() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const parameters = { location: "eastus" };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.resourceGroups.createOrUpdate(resourceGroupName, parameters);
  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

Sample Response

Status code:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
  "name": "my-resource-group",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded"
  }
}

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
  "name": "my-resource-group",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded"
  }
}

定義

名稱	Description
CloudError	資源管理要求的錯誤回應。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
ResourceGroup	資源群組資訊。
ResourceGroupProperties	資源群組屬性。

CloudError

資源管理要求的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應 所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。)

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ResourceGroup

資源群組資訊。

名稱	類型	Description
id	string	資源群組的標識碼。
location	string	資源群組的位置。 建立資源群組之後無法變更它。 它必須是其中一個支援的 Azure 位置。
managedBy	string	管理此資源群組之資源的標識碼。
name	string	資源群組的名稱。
properties	ResourceGroupProperties	資源群組屬性。
tags	object	附加至資源群組的標記。
type	string	資源群組的類型。

ResourceGroupProperties

資源群組屬性。

名稱	類型	Description
provisioningState	string	布建狀態。