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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	作成または更新するリソース グループの名前。 英数字、アンダースコア、かっこ、ハイフン、ピリオド (末尾を除く)、および使用できる文字に一致する Unicode 文字を含めることができます。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Microsoft Azure サブスクリプション ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソース グループの場所。 リソース グループの作成後に変更することはできません。 サポートされている Azure の場所のいずれかである必要があります。
managedBy		string	このリソース グループを管理するリソースの ID。
properties		ResourceGroupProperties	リソース グループのプロパティ。
tags		object	リソース グループにアタッチされているタグ。

応答

名前	型	説明
200 OK	ResourceGroup	OK - 新しいリソース グループに関する情報を返します。
201 Created	ResourceGroup	Created - 新しいリソース グループに関する情報を返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
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"
  }
}

定義

名前	説明
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
ResourceGroup	リソース グループの情報です。
ResourceGroupProperties	リソース グループのプロパティ。

CloudError

リソース管理要求のエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

ErrorAdditionalInfo

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

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

ErrorResponse

エラー応答

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

ResourceGroup

リソース グループの情報です。

名前	型	説明
id	string	リソース グループの ID。
location	string	リソース グループの場所。 リソース グループの作成後に変更することはできません。 サポートされている Azure の場所のいずれかである必要があります。
managedBy	string	このリソース グループを管理するリソースの ID。
name	string	リソース グループの名前。
properties	ResourceGroupProperties	リソース グループのプロパティ。
tags	object	リソース グループにアタッチされているタグ。
type	string	リソース グループの種類。

ResourceGroupProperties

リソース グループのプロパティ。

名前	型	説明
provisioningState	string	プロビジョニングの状態。