你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Certificate - Cancel Deletion

Service:

Batch Management

API Version:

2024-02-01

从指定的帐户中取消某个删除失败的证书。
如果尝试删除池或计算节点正在使用的证书，证书的状态将更改为 deleteFailed。 如果你确定要继续使用该证书，可以使用此操作将该证书的状态设置回到 active。 如果你想要删除该证书，在删除失败后，你不需要运行此操作。 必须确保该证书未由任何资源使用，然后可以重新尝试删除该证书。

警告：此操作已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展 。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Batch 帐户的名称。 Regex pattern: ^[a-zA-Z0-9]+$
certificateName	path	True	string	证书的标识符。 这必须由用短划线分隔的算法和指纹组成，并且必须与请求中的证书数据匹配。 例如 SHA1-a3d1c5。 Regex pattern: ^[\w]+-[\w]+$
resourceGroupName	path	True	string	包含 Batch 帐户的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000)
api-version	query	True	string	要与 HTTP 请求一起使用的 API 版本。

响应

名称	类型	说明
200 OK	Certificate	操作成功。 响应包含证书实体。 Headers ETag: string
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

CertificateCancelDeletion

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e/cancelDelete?api-version=2024-02-01

Java

/**
 * Samples for Certificate CancelDeletion.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/CertificateCancelDeletion.json
     */
    /**
     * Sample code: CertificateCancelDeletion.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void certificateCancelDeletion(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.certificates().cancelDeletionWithResponse("default-azurebatch-japaneast", "sampleacct",
            "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", 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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python certificate_cancel_deletion.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.certificate.cancel_deletion(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        certificate_name="sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/CertificateCancelDeletion.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

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/CertificateCancelDeletion.json
func ExampleCertificateClient_CancelDeletion() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificateClient().CancelDeletion(ctx, "default-azurebatch-japaneast", "sampleacct", "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", 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.Certificate = armbatch.Certificate{
	// 	Name: to.Ptr("sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/certificates"),
	// 	Etag: to.Ptr("W/\"0x8D4EDD513C3EDBB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e"),
	// 	Properties: &armbatch.CertificateProperties{
	// 		Format: to.Ptr(armbatch.CertificateFormatPfx),
	// 		Thumbprint: to.Ptr("0a0e4f50d51beadeac1d35afc5116098e7902e6e"),
	// 		ThumbprintAlgorithm: to.Ptr("sha1"),
	// 		PreviousProvisioningState: to.Ptr(armbatch.CertificateProvisioningStateFailed),
	// 		PreviousProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-07-21T00:22:54.329Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbatch.CertificateProvisioningStateSucceeded),
	// 		ProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-07-21T01:47:38.442Z"); return t}()),
	// 		PublicData: to.Ptr("MIICrjCCAZagAwI..."),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
 *
 * @summary If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/CertificateCancelDeletion.json
 */
async function certificateCancelDeletion() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const certificateName = "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.certificateOperations.cancelDeletion(
    resourceGroupName,
    accountName,
    certificateName,
  );
  console.log(result);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/CertificateCancelDeletion.json
// this example is just showing the usage of "Certificate_CancelDeletion" 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 BatchAccountCertificateResource created on azure
// for more information of creating BatchAccountCertificateResource, please refer to the document of BatchAccountCertificateResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string certificateName = "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e";
ResourceIdentifier batchAccountCertificateResourceId = BatchAccountCertificateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, certificateName);
BatchAccountCertificateResource batchAccountCertificate = client.GetBatchAccountCertificateResource(batchAccountCertificateResourceId);

// invoke the operation
BatchAccountCertificateResource result = await batchAccountCertificate.CancelDeletionAsync();

// 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
BatchAccountCertificateData 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

Sample Response

Status code:

200

ETag: W/"0x8D4EDD513C3EDBB"

Response Body

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
  "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
  "type": "Microsoft.Batch/batchAccounts/certificates",
  "etag": "W/\"0x8D4EDD513C3EDBB\"",
  "properties": {
    "thumbprintAlgorithm": "sha1",
    "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
    "previousProvisioningState": "Failed",
    "previousProvisioningStateTransitionTime": "2017-07-21T00:22:54.3299195Z",
    "format": "Pfx",
    "publicData": "MIICrjCCAZagAwI..."
  }
}

定义

名称	说明
Certificate	包含有关证书的信息。
CertificateFormat	证书的格式 - Pfx 或 Cer。 如果省略，则默认值为 Pfx。
CertificateProvisioningState	资源的预配状态
CloudError	Batch 服务的错误响应。
CloudErrorBody	Batch 服务的错误响应。
DeleteCertificateError	Batch 服务的错误响应。

Certificate

包含有关证书的信息。

名称	类型	说明
etag	string	资源的 ETag，用于并发语句。
id	string	资源的 ID。
name	string	资源的名称。
properties.deleteCertificateError	DeleteCertificateError	删除证书时发生的错误 仅当证书 provisioningState 为“Failed”时，才会返回此值。
properties.format	CertificateFormat	证书的格式 - Pfx 或 Cer。 如果省略，则默认值为 Pfx。
properties.previousProvisioningState	CertificateProvisioningState	资源的以前预配状态
properties.previousProvisioningStateTransitionTime	string	证书进入其先前状态的时间。
properties.provisioningState	CertificateProvisioningState	资源的预配状态
properties.provisioningStateTransitionTime	string	证书进入其当前状态的时间。
properties.publicData	string	证书的公钥。
properties.thumbprint	string	证书的指纹。 这必须与名称中的指纹匹配。
properties.thumbprintAlgorithm	string	证书指纹的算法。 这必须与证书名称的第一部分匹配。 当前必须为“SHA1”。
type	string	资源类型。

CertificateFormat

证书的格式 - Pfx 或 Cer。 如果省略，则默认值为 Pfx。

名称	类型	说明
Cer	string	该证书是 base64 编码的 X.509 证书。
Pfx	string	证书是 PFX (PKCS#12) 格式证书或证书链。

CertificateProvisioningState

资源的预配状态

名称	类型	说明
Deleting	string	用户已请求删除证书，但删除操作尚未完成。 创建或更新池时，不得引用证书。
Failed	string	用户请求删除证书，但仍有一些池引用了证书，或者它仍安装在一个或多个计算节点上。 (如果证书已从池中删除，但节点尚未重启，则可能发生后者。节点仅在重启时刷新其证书。) 可以使用取消证书删除操作来取消删除，也可以使用删除证书操作重试删除操作。
Succeeded	string	证书可用于池。

CloudError

Batch 服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误响应的正文。

CloudErrorBody

Batch 服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

DeleteCertificateError

Batch 服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	DeleteCertificateError[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。