Changes - Get

リファレンス

サービス:: Resource Management

API バージョン:: 2022-05-01

ターゲットリソースの指定された変更リソースを取得します

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Resources/changes/{changeResourceId}?api-version=2022-05-01

URI パラメーター

名前	/	必須	型	説明
changeResourceId	path	True	string	変更リソースの ID
resourceGroupName	path	True	string	リソースグループの名前。
resourceName	path	True	string	リソースの名前。
resourceProviderNamespace	path	True	string	リソースプロバイダー名前空間の名前。
resourceType	path	True	string	リソースの種類の名前。
subscriptionId	path	True	string	Azure サブスクリプション ID。これは GUID 形式の文字列です (例: 00000000-0000-0000-0000-000000000000)
api-version	query	True	string	HTTP 要求で使用される API バージョン。

応答

名前	型	説明
200 OK	ChangeResourceResult	OK です。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

GetChange

要求のサンプル

GET https://management.azure.com/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/providers/Microsoft.Resources/changes/1d58d72f-0719-4a48-9228-b7ea682885bf?api-version=2022-05-01


/**
 * Samples for Changes Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/GetChange.json
     */
    /**
     * Sample code: GetChange.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getChange(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().resourceChangeClient().getChanges().getWithResponse("resourceGroup1",
            "resourceProvider1", "resourceType1", "resourceName1", "1d58d72f-0719-4a48-9228-b7ea682885bf",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import ChangesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_change.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 = ChangesClient(
        credential=DefaultAzureCredential(),
        subscription_id="subscriptionId1",
    )

    response = client.changes.get(
        resource_group_name="resourceGroup1",
        resource_provider_namespace="resourceProvider1",
        resource_type="resourceType1",
        resource_name="resourceName1",
        change_resource_id="1d58d72f-0719-4a48-9228-b7ea682885bf",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/GetChange.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 armchanges_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armchanges"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0cc5e2efd6ffccf30e80d1e150b488dd87198b94/specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/GetChange.json
func ExampleClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armchanges.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().Get(ctx, "resourceGroup1", "resourceProvider1", "resourceType1", "resourceName1", "1d58d72f-0719-4a48-9228-b7ea682885bf", 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.ChangeResourceResult = armchanges.ChangeResourceResult{
	// 	Name: to.Ptr("1d58d72f-0719-4a48-9228-b7ea682885bf"),
	// 	Type: to.Ptr("Microsoft.Resources/changes"),
	// 	ID: to.Ptr("/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/1d58d72f-0719-4a48-9228-b7ea682885bf"),
	// 	Properties: &armchanges.ChangeProperties{
	// 		ChangeAttributes: &armchanges.ChangeAttributes{
	// 			ChangesCount: to.Ptr[int64](2),
	// 			CorrelationID: to.Ptr("88420d5d-8d0e-471f-9115-10d34750c617"),
	// 			NewResourceSnapshotID: to.Ptr("6eac9d0f-63b4-4e7f-97a5-740c73757efb"),
	// 			PreviousResourceSnapshotID: to.Ptr("ed90e35a-1661-42cc-a44c-e27f508005be"),
	// 			Timestamp: to.Ptr("2021-11-19T14:29:09.9210000Z"),
	// 		},
	// 		ChangeType: to.Ptr(armchanges.ChangeTypeUpdate),
	// 		Changes: map[string]*armchanges.ChangeBase{
	// 			"properties.provisioningState": &armchanges.ChangeBase{
	// 				ChangeCategory: to.Ptr(armchanges.ChangeCategorySystem),
	// 				NewValue: to.Ptr("Succeeded"),
	// 				PreviousValue: to.Ptr("Updating"),
	// 				PropertyChangeType: to.Ptr(armchanges.PropertyChangeTypeUpdate),
	// 			},
	// 			"tags.key1": &armchanges.ChangeBase{
	// 				ChangeCategory: to.Ptr(armchanges.ChangeCategoryUser),
	// 				NewValue: to.Ptr("someValue"),
	// 				PreviousValue: to.Ptr("null"),
	// 				PropertyChangeType: to.Ptr(armchanges.PropertyChangeTypeInsert),
	// 			},
	// 		},
	// 		TargetResourceID: to.Ptr("/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1"),
	// 		TargetResourceType: to.Ptr("resourceProvider1/resourceType1"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Obtains the specified change resource for the target resource
 *
 * @summary Obtains the specified change resource for the target resource
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/GetChange.json
 */
async function getChange() {
  const subscriptionId = "subscriptionId1";
  const resourceGroupName = "resourceGroup1";
  const resourceProviderNamespace = "resourceProvider1";
  const resourceType = "resourceType1";
  const resourceName = "resourceName1";
  const changeResourceId = "1d58d72f-0719-4a48-9228-b7ea682885bf";
  const credential = new DefaultAzureCredential();
  const client = new ChangesClient(credential, subscriptionId);
  const result = await client.changes.get(
    resourceGroupName,
    resourceProviderNamespace,
    resourceType,
    resourceName,
    changeResourceId
  );
  console.log(result);
}

getChange().catch(console.error);

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/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/1d58d72f-0719-4a48-9228-b7ea682885bf",
  "name": "1d58d72f-0719-4a48-9228-b7ea682885bf",
  "type": "Microsoft.Resources/changes",
  "properties": {
    "targetResourceId": "/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1",
    "targetResourceType": "resourceProvider1/resourceType1",
    "changeType": "Update",
    "changeAttributes": {
      "correlationId": "88420d5d-8d0e-471f-9115-10d34750c617",
      "timestamp": "2021-11-19T14:29:09.9210000Z",
      "changesCount": 2,
      "previousResourceSnapshotId": "ed90e35a-1661-42cc-a44c-e27f508005be",
      "newResourceSnapshotId": "6eac9d0f-63b4-4e7f-97a5-740c73757efb"
    },
    "changes": {
      "properties.provisioningState": {
        "propertyChangeType": "Update",
        "changeCategory": "System",
        "previousValue": "Updating",
        "newValue": "Succeeded"
      },
      "tags.key1": {
        "propertyChangeType": "Insert",
        "changeCategory": "User",
        "previousValue": "null",
        "newValue": "someValue"
      }
    }
  }
}

定義

名前	説明
ChangeAttributes	変更リソースの詳細
ChangeBase	ターゲットリソースに対する個々の変更
ChangeCategory	変更を行ったエンティティ
ChangeProperties	変更のプロパティ
ChangeResourceResult	リソースの変更
ChangeType	リソースでキャプチャされた変更の種類
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PropertyChangeType	発生した変更の種類

ChangeAttributes

変更リソースの詳細

名前	型	説明
changesCount	integer	このリソースがキャプチャする変更の数
correlationId	string	変更リソースの ARM 相関 ID
newResourceSnapshotId	string	新しいスナップショットの GUID
previousResourceSnapshotId	string	前のスナップショットの GUID
timestamp	string	ターゲットリソースの変更が発生した時刻

ChangeBase

ターゲットリソースに対する個々の変更

名前	型	説明
changeCategory	ChangeCategory	変更を行ったエンティティ
newValue	string	変更後のターゲットリソースプロパティの値
previousValue	string	変更前のターゲットリソースプロパティの値
propertyChangeType	PropertyChangeType	発生した変更の種類

ChangeCategory

変更を行ったエンティティ

名前	型	説明
System	string	システムによって開始される変更
User	string	ユーザーが開始した変更

ChangeProperties

変更のプロパティ

名前	型	説明
changeAttributes	ChangeAttributes	変更リソースの詳細
changeType	ChangeType	リソースでキャプチャされた変更の種類
changes	<string, ChangeBase>	変更されたプロパティ名をキーとして、変更の詳細を値として持つディクショナリ
targetResourceId	string	変更されたターゲットリソースの完全修飾 ID
targetResourceType	string	リソースの名前空間と型

ChangeResourceResult

リソースの変更

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	ChangeProperties	変更のプロパティ
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ChangeType

リソースでキャプチャされた変更の種類

名前	型	説明
Create	string	新しく作成されたリソース
Delete	string	既存のリソースが削除されました
Update	string	既存のリソースに変更が発生しました

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

PropertyChangeType

発生した変更の種類

名前	型	説明
Insert	string	プロパティが新しく作成されました
Remove	string	既存のプロパティが削除されました
Update	string	既存のプロパティに変更が発生しました

次の方法で共有

Changes - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

GetChange

要求のサンプル

応答のサンプル

定義

ChangeAttributes

ChangeBase

ChangeCategory

ChangeProperties

ChangeResourceResult

ChangeType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PropertyChangeType

その他のリソース