Changes - List

Reference

Service:: Resource Management

API Version:: 2022-05-01

Obtains a list of change resources from the past 14 days for the target resource

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

With optional parameters:

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 Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
resourceName	path	True	string	The name of the resource.
resourceProviderNamespace	path	True	string	The name of the resource provider namespace.
resourceType	path	True	string	The name of the resource type.
subscriptionId	path	True	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
api-version	query	True	string	The API version to be used with the HTTP request.
$skipToken	query		string	(Optional) The page-continuation token
$top	query		integer int64	(Optional) Set the maximum number of results per response.

Responses

Name	Type	Description
200 OK	ChangeResourceListResult	OK.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListChanges

Sample Request

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

Sample Response

Status code:: 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": {}
      }
    }
  ]
}

Definitions

Name	Description
ChangeAttributes	Details about the change resource
ChangeBase	An individual change on the target resource
ChangeCategory	The entity that made the change
ChangeProperties	The properties of a change
ChangeResourceListResult	The list of resources
ChangeResourceResult	Change Resource
ChangeType	The type of change that was captured in the resource
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PropertyChangeType	The type of change that occurred

ChangeAttributes

Details about the change resource

Name	Type	Description
changesCount	integer	The number of changes this resource captures
correlationId	string	The ARM correlation ID of the change resource
newResourceSnapshotId	string	The GUID of the new snapshot
previousResourceSnapshotId	string	The GUID of the previous snapshot
timestamp	string	The time the change(s) on the target resource ocurred

ChangeBase

An individual change on the target resource

Name	Type	Description
changeCategory	ChangeCategory	The entity that made the change
newValue	string	The target resource property value after the change
previousValue	string	The target resource property value before the change
propertyChangeType	PropertyChangeType	The type of change that occurred

ChangeCategory

The entity that made the change

Name	Type	Description
System	string	System initiated change
User	string	User initiated change

ChangeProperties

The properties of a change

Name	Type	Description
changeAttributes	ChangeAttributes	Details about the change resource
changeType	ChangeType	The type of change that was captured in the resource
changes	<string, ChangeBase>	A dictionary with changed property name as a key and the change details as the value
targetResourceId	string	The fully qualified ID of the target resource that was changed
targetResourceType	string	The namespace and type of the resource

ChangeResourceListResult

The list of resources

Name	Type	Description
nextLink	string	The link used to get the next page of Change Resources
value	ChangeResourceResult[]	The list of resources

ChangeResourceResult

Change Resource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	ChangeProperties	The properties of a change
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ChangeType

The type of change that was captured in the resource

Name	Type	Description
Create	string	A newly created resource
Delete	string	An existing resource was deleted
Update	string	An existing resource underwent a change

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PropertyChangeType

The type of change that occurred

Name	Type	Description
Insert	string	A property was newly created
Remove	string	An existing property was deleted
Update	string	An existing property underwent a change

Changes - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ListChanges

Sample Request

Sample Response

Definitions

ChangeAttributes

ChangeBase

ChangeCategory

ChangeProperties

ChangeResourceListResult

ChangeResourceResult

ChangeType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PropertyChangeType

Additional resources