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 參數

名稱	位於	必要	類型	Description
changeResourceId	path	True	string	變更資源的標識碼
resourceGroupName	path	True	string	資源群組的名稱。
resourceName	path	True	string	資源名稱。
resourceProviderNamespace	path	True	string	資源提供者命名空間的名稱。
resourceType	path	True	string	資源類型的名稱。
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。這是 GUID 格式的字串 (例如 0000000000-0000-0000-0000-0000000000000)
api-version	query	True	string	要與 HTTP 要求搭配使用的 API 版本。

回應

名稱	類型	Description
200 OK	ChangeResourceResult	正常。
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	模擬您的用戶帳戶

範例

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"
      }
    }
  }
}

定義

名稱	Description
ChangeAttributes	變更資源的詳細數據
ChangeBase	目標資源的個別變更
ChangeCategory	進行變更的實體
ChangeProperties	變更的屬性
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	資源的命名空間和類型

ChangeResourceResult

變更資源

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /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	error 物件。

PropertyChangeType

發生的變更類型

名稱	類型	Description
Insert	string	新建立的屬性
Remove	string	已刪除現有的屬性
Update	string	現有屬性在變更下執行變更

共用方式為

Changes - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

GetChange

範例要求

範例回覆

定義

ChangeAttributes

ChangeBase

ChangeCategory

ChangeProperties

ChangeResourceResult

ChangeType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PropertyChangeType

其他資源