Changes - List

參考

服務:: Resource Management

API 版本:: 2022-05-01

取得目標資源的過去 14 天內的變更資源清單

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
resourceName	path	True	string	資源名稱。
resourceProviderNamespace	path	True	string	資源提供者命名空間的名稱。
resourceType	path	True	string	資源類型的名稱。
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。這是 GUID 格式字串 (例如 000000000-0000-0000-0000-00000-000000000000)
api-version	query	True	string	要與 HTTP 要求搭配使用的 API 版本。
$skipToken	query		string	(選擇性) 頁面接續令牌
$top	query		integer int64	(選擇性) 設定每個響應的結果數目上限。

回應

名稱	類型	Description
200 OK	ChangeResourceListResult	正常。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

ListChanges

範例要求

GET https://management.azure.com/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/providers/Microsoft.Resources/changes?api-version=2022-05-01


/**
 * Samples for Changes List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/ListChanges.json
     */
    /**
     * Sample code: ListChanges.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listChanges(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().resourceChangeClient().getChanges().list("resourceGroup1",
            "resourceProvider1", "resourceType1", "resourceName1", null, null, 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 list_changes.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.list(
        resource_group_name="resourceGroup1",
        resource_provider_namespace="resourceProvider1",
        resource_type="resourceType1",
        resource_name="resourceName1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/ListChanges.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/ListChanges.json
func ExampleClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewClient().NewListPager("resourceGroup1", "resourceProvider1", "resourceType1", "resourceName1", &armchanges.ClientListOptions{Top: nil,
		SkipToken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ChangeResourceListResult = armchanges.ChangeResourceListResult{
		// 	Value: []*armchanges.ChangeResourceResult{
		// 		{
		// 			Name: to.Ptr("a9f34285-13a2-e79c-f468-cfb71c7bd227"),
		// 			Type: to.Ptr("Microsoft.Resources/changes"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227"),
		// 			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"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("a9f34285-13a2-e79c-f468-cfb71c7bd227"),
		// 			Type: to.Ptr("Microsoft.Resources/changes"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227"),
		// 			Properties: &armchanges.ChangeProperties{
		// 				ChangeAttributes: &armchanges.ChangeAttributes{
		// 					ChangesCount: to.Ptr[int64](0),
		// 					CorrelationID: to.Ptr("88420d5d-8d0e-471f-9115-10d34750c617"),
		// 					NewResourceSnapshotID: to.Ptr("4db20fc0-de17-4cdd-92d8-fd6bf94b9fd9"),
		// 					PreviousResourceSnapshotID: to.Ptr("b09f5e52-0b46-4d13-84a9-08653d39fed6"),
		// 					Timestamp: to.Ptr("2021-11-19T14:29:09.9210000Z"),
		// 				},
		// 				ChangeType: to.Ptr(armchanges.ChangeTypeCreate),
		// 				Changes: map[string]*armchanges.ChangeBase{
		// 				},
		// 				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 a list of change resources from the past 14 days for the target resource
 *
 * @summary Obtains a list of change resources from the past 14 days for the target resource
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-05-01/examples/ListChanges.json
 */
async function listChanges() {
  const subscriptionId = "subscriptionId1";
  const resourceGroupName = "resourceGroup1";
  const resourceProviderNamespace = "resourceProvider1";
  const resourceType = "resourceType1";
  const resourceName = "resourceName1";
  const credential = new DefaultAzureCredential();
  const client = new ChangesClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.changes.list(
    resourceGroupName,
    resourceProviderNamespace,
    resourceType,
    resourceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

listChanges().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

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227",
      "name": "a9f34285-13a2-e79c-f468-cfb71c7bd227",
      "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"
          }
        }
      }
    },
    {
      "id": "/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227",
      "name": "a9f34285-13a2-e79c-f468-cfb71c7bd227",
      "type": "Microsoft.Resources/changes",
      "properties": {
        "targetResourceId": "/subscriptions/subscriptionId1/resourceGroups/resourceGroup1/providers/resourceProvider1/resourceType1/resourceName1",
        "targetResourceType": "resourceProvider1/resourceType1",
        "changeType": "Create",
        "changeAttributes": {
          "changesCount": 0,
          "correlationId": "88420d5d-8d0e-471f-9115-10d34750c617",
          "timestamp": "2021-11-19T14:29:09.9210000Z",
          "previousResourceSnapshotId": "b09f5e52-0b46-4d13-84a9-08653d39fed6",
          "newResourceSnapshotId": "4db20fc0-de17-4cdd-92d8-fd6bf94b9fd9"
        },
        "changes": {}
      }
    }
  ]
}

定義

名稱	Description
ChangeAttributes	變更資源的詳細數據
ChangeBase	目標資源的個別變更
ChangeCategory	進行變更的實體
ChangeProperties	變更的屬性
ChangeResourceListResult	資源清單
ChangeResourceResult	變更資源
ChangeType	在資源中擷取的變更類型
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
PropertyChangeType	發生的變更類型

ChangeAttributes

變更資源的詳細數據

名稱	類型	Description
changesCount	integer	此資源擷取的變更數目
correlationId	string	變更資源的 ARM 相互關聯標識碼
newResourceSnapshotId	string	新快照集的 GUID
previousResourceSnapshotId	string	上一個快照集的 GUID
timestamp	string	目標資源上變更 () 的時間

ChangeBase

目標資源的個別變更

名稱	類型	Description
changeCategory	ChangeCategory	進行變更的實體
newValue	string	變更之後的目標資源屬性值
previousValue	string	變更之前的目標資源屬性值
propertyChangeType	PropertyChangeType	發生的變更類型

ChangeCategory

進行變更的實體

名稱	類型	Description
System	string	系統起始的變更
User	string	使用者起始的變更

ChangeProperties

變更的屬性

名稱	類型	Description
changeAttributes	ChangeAttributes	變更資源的詳細數據
changeType	ChangeType	在資源中擷取的變更類型
changes	<string, ChangeBase>	具有已變更屬性名稱做為索引鍵的字典，以及變更詳細數據做為值
targetResourceId	string	已變更之目標資源的完整標識碼
targetResourceType	string	資源的命名空間和類型

ChangeResourceListResult

資源清單

名稱	類型	Description
nextLink	string	用來取得下一頁變更資源的連結
value	ChangeResourceResult[]	資源清單

ChangeResourceResult

變更資源

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	ChangeProperties	變更的屬性
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ChangeType

在資源中擷取的變更類型

名稱	類型	Description
Create	string	新建立的資源
Delete	string	已刪除現有的資源
Update	string	現有資源下移變更

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

PropertyChangeType

發生的變更類型

名稱	類型	Description
Insert	string	新建立的屬性
Remove	string	已刪除現有的屬性
Update	string	現有屬性在變更時發生變更

共用方式為

Changes - List

URI 參數

回應

安全性

azure_auth

範圍

範例

ListChanges

範例要求

範例回覆

定義

ChangeAttributes

ChangeBase

ChangeCategory

ChangeProperties

ChangeResourceListResult

ChangeResourceResult

ChangeType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PropertyChangeType

其他資源