Apply Updates - Create Or Update Or Cancel

參考

服務:: Maintenance

API 版本:: 2023-09-01-preview

將更新套用至資源
將維護更新套用至資源

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}?api-version=2023-09-01-preview

URI 參數

名稱	位於	必要	類型	Description
applyUpdateName	path	True	string	ApplyUpdate 名稱
providerName	path	True	string	資源提供者名稱
resourceGroupName	path	True	string	資源組名
resourceName	path	True	string	資源標識碼
resourceType	path	True	string	資源類型
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	類型	Description
properties.lastUpdateTime	string (date-time)	上次更新時間
properties.resourceId	string	resourceId
properties.status	UpdateStatus	狀態

回應

名稱	類型	Description
200 OK	ApplyUpdate	已接受ApplyUpdate更新要求
201 Created	ApplyUpdate	ApplyUpdate 建立要求已接受
Other Status Codes	MaintenanceError	錯誤的請求

範例

ApplyUpdates_CreateOrUpdateOnly_NoCancellation

ApplyUpdates_CreateOrUpdateOrCancel

ApplyUpdates_CreateOrUpdateOnly_NoCancellation

範例要求

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/20230901121200?api-version=2023-09-01-preview

{}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Maintenance;
using Azure.ResourceManager.Maintenance.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ApplyUpdates_CreateOrUpdateOnly_NoCancellation.json
// this example is just showing the usage of "ApplyUpdates_CreateOrUpdateOrCancel" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MaintenanceApplyUpdateResource created on azure
// for more information of creating MaintenanceApplyUpdateResource, please refer to the document of MaintenanceApplyUpdateResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string providerName = "Microsoft.Compute";
string resourceType = "virtualMachineScaleSets";
string resourceName = "smdtest1";
string applyUpdateName = "20230901121200";
ResourceIdentifier maintenanceApplyUpdateResourceId = MaintenanceApplyUpdateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, providerName, resourceType, resourceName, applyUpdateName);
MaintenanceApplyUpdateResource maintenanceApplyUpdate = client.GetMaintenanceApplyUpdateResource(maintenanceApplyUpdateResourceId);

// invoke the operation
MaintenanceApplyUpdateData data = new MaintenanceApplyUpdateData();
ArmOperation<MaintenanceApplyUpdateResource> lro = await maintenanceApplyUpdate.UpdateAsync(WaitUntil.Completed, data);
MaintenanceApplyUpdateResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MaintenanceApplyUpdateData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1",
    "status": "Pending"
  }
}

狀態碼:: 201

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1",
    "status": "Pending"
  }
}

ApplyUpdates_CreateOrUpdateOrCancel

範例要求

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/maintenanceConfig1/providers/Microsoft.Maintenance/applyUpdates/20230901121200?api-version=2023-09-01-preview

{
  "properties": {
    "status": "Cancel"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.maintenance import MaintenanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maintenance
# USAGE
    python apply_updates_create_or_update_cancel_maintenance.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 = MaintenanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.apply_updates.create_or_update_or_cancel(
        resource_group_name="examplerg",
        provider_name="Microsoft.Maintenance",
        resource_type="maintenanceConfigurations",
        resource_name="maintenanceConfig1",
        apply_update_name="20230901121200",
        apply_update={"properties": {"status": "Cancel"}},
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ApplyUpdates_CreateOrUpdate_CancelMaintenance.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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Maintenance;
using Azure.ResourceManager.Maintenance.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ApplyUpdates_CreateOrUpdate_CancelMaintenance.json
// this example is just showing the usage of "ApplyUpdates_CreateOrUpdateOrCancel" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MaintenanceApplyUpdateResource created on azure
// for more information of creating MaintenanceApplyUpdateResource, please refer to the document of MaintenanceApplyUpdateResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string providerName = "Microsoft.Maintenance";
string resourceType = "maintenanceConfigurations";
string resourceName = "maintenanceConfig1";
string applyUpdateName = "20230901121200";
ResourceIdentifier maintenanceApplyUpdateResourceId = MaintenanceApplyUpdateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, providerName, resourceType, resourceName, applyUpdateName);
MaintenanceApplyUpdateResource maintenanceApplyUpdate = client.GetMaintenanceApplyUpdateResource(maintenanceApplyUpdateResourceId);

// invoke the operation
MaintenanceApplyUpdateData data = new MaintenanceApplyUpdateData()
{
    Status = MaintenanceUpdateStatus.Cancel,
};
ArmOperation<MaintenanceApplyUpdateResource> lro = await maintenanceApplyUpdate.UpdateAsync(WaitUntil.Completed, data);
MaintenanceApplyUpdateResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MaintenanceApplyUpdateData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1/providers/microsoft.maintenance/applyupdates/20230901121200",
  "name": "maintenanceConfig1",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "status": "Cancelled",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1"
  }
}

狀態碼:: 201

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1/providers/microsoft.maintenance/applyupdates/20230901121200",
  "name": "maintenanceConfig1",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "status": "Cancelled",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1"
  }
}

定義

名稱	Description
ApplyUpdate	套用更新要求
createdByType	建立資源的身分識別類型。
ErrorDetails	從 Azure 維護服務收到的錯誤回應詳細數據。
MaintenanceError	從 Azure 維護服務收到的錯誤回應。
systemData	與建立和上次修改資源相關的元數據。
UpdateStatus	狀態

ApplyUpdate

Object

套用更新要求

名稱	類型	Description
id	string	資源的完整標識碼
name	string	資源的名稱
properties.lastUpdateTime	string (date-time)	上次更新時間
properties.resourceId	string	resourceId
properties.status	UpdateStatus	狀態
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Object

從 Azure 維護服務收到的錯誤回應詳細數據。

名稱	類型	Description
code	string	服務定義的錯誤碼。此程式代碼可作為回應中所指定 HTTP 錯誤碼的子狀態。
message	string	人類可讀取的錯誤表示法。

MaintenanceError

Object

從 Azure 維護服務收到的錯誤回應。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UpdateStatus

列舉型別

狀態

值	Description
Cancel	取消排程，並停止為其一部分的資源建立 PMR。僅適用於維護設定資源類型。
Cancelled	如果要求來取消排程，請將 Canceled 回應傳送給使用者。僅適用於維護設定資源類型。
Completed	已成功套用所有更新。
InProgress	更新安裝正在進行中。
NoUpdatesPending	沒有任何更新擱置中。
Pending	有擱置的更新要安裝。
RetryLater	更新安裝失敗，稍後應重試。
RetryNow	更新安裝失敗，但已準備好再次重試。

共用方式為

Apply Updates - Create Or Update Or Cancel

URI 參數

要求本文

回應

範例

ApplyUpdates_CreateOrUpdateOnly_NoCancellation

範例要求

範例回覆

ApplyUpdates_CreateOrUpdateOrCancel

範例要求

範例回覆

定義

ApplyUpdate

createdByType

ErrorDetails

MaintenanceError

systemData

UpdateStatus

其他資源