App Service Certificate Orders - Validate Purchase Information

サービス:

App Service

API バージョン:

2024-04-01

証明書の注文の検証情報の説明。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation?api-version=2024-04-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
api-version	query	True	string	API バージョン

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
properties.productType	True	CertificateProductType	証明書製品の種類。
kind		string	リソースの種類。 リソースがアプリの場合は、サポートされている種類の値の詳細については、https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference を参照してください。
properties.autoRenew		boolean	証明書の有効期限が切れたときに証明書を自動的に更新する必要があるかどうかを true します。それ以外の場合は、falseします。
properties.certificates		<string,  AppServiceCertificate>	Key Vault シークレットの状態。
properties.csr		string	この注文に対して作成された最後の CSR。
properties.distinguishedName		string	証明書の識別名。
properties.keySize		integer (int32)	証明書キーのサイズ。
properties.validityInYears		integer (int32)	年単位の期間 (1 にする必要があります)。
tags		object	リソース タグ。

応答

名前	型	説明
204 No Content		コンテンツなし
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Validate App Service Certificate purchase information by subscription

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation?api-version=2024-04-01

{
  "location": "Global",
  "properties": {
    "certificates": {
      "SampleCertName1": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName1"
      },
      "SampleCertName2": {
        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        "keyVaultSecretName": "SampleSecretName2"
      }
    },
    "distinguishedName": "CN=SampleCustomDomain.com",
    "validityInYears": 2,
    "keySize": 2048,
    "productType": "StandardDomainValidatedSsl",
    "autoRenew": true
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.AppServiceCertificateInner;
import com.azure.resourcemanager.appservice.fluent.models.AppServiceCertificateOrderInner;
import com.azure.resourcemanager.appservice.models.CertificateProductType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for AppServiceCertificateOrders ValidatePurchaseInformation.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/
     * ValidateAppServiceCertificatePurchaseInformationBySubscription.json
     */
    /**
     * Sample code: Validate App Service Certificate purchase information by subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void validateAppServiceCertificatePurchaseInformationBySubscription(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceCertificateOrders()
            .validatePurchaseInformationWithResponse(
                new AppServiceCertificateOrderInner().withLocation("Global")
                    .withCertificates(mapOf("SampleCertName1",
                        new AppServiceCertificateInner()
                            .withKeyVaultId("fakeTokenPlaceholder").withKeyVaultSecretName("fakeTokenPlaceholder"),
                        "SampleCertName2",
                        new AppServiceCertificateInner().withKeyVaultId("fakeTokenPlaceholder")
                            .withKeyVaultSecretName("fakeTokenPlaceholder")))
                    .withDistinguishedName("CN=SampleCustomDomain.com").withValidityInYears(2).withKeySize(2048)
                    .withProductType(CertificateProductType.STANDARD_DOMAIN_VALIDATED_SSL).withAutoRenew(true),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python validate_app_service_certificate_purchase_information_by_subscription.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    client.app_service_certificate_orders.validate_purchase_information(
        app_service_certificate_order={
            "location": "Global",
            "properties": {
                "autoRenew": True,
                "certificates": {
                    "SampleCertName1": {
                        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
                        "keyVaultSecretName": "SampleSecretName1",
                    },
                    "SampleCertName2": {
                        "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
                        "keyVaultSecretName": "SampleSecretName2",
                    },
                },
                "distinguishedName": "CN=SampleCustomDomain.com",
                "keySize": 2048,
                "productType": "StandardDomainValidatedSsl",
                "validityInYears": 2,
            },
        },
    )


# x-ms-original-file: specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.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 armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json
func ExampleCertificateOrdersClient_ValidatePurchaseInformation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewCertificateOrdersClient().ValidatePurchaseInformation(ctx, armappservice.CertificateOrder{
		Location: to.Ptr("Global"),
		Properties: &armappservice.CertificateOrderProperties{
			AutoRenew: to.Ptr(true),
			Certificates: map[string]*armappservice.Certificate{
				"SampleCertName1": {
					KeyVaultID:         to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName"),
					KeyVaultSecretName: to.Ptr("SampleSecretName1"),
				},
				"SampleCertName2": {
					KeyVaultID:         to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName"),
					KeyVaultSecretName: to.Ptr("SampleSecretName2"),
				},
			},
			DistinguishedName: to.Ptr("CN=SampleCustomDomain.com"),
			KeySize:           to.Ptr[int32](2048),
			ProductType:       to.Ptr(armappservice.CertificateProductTypeStandardDomainValidatedSSL),
			ValidityInYears:   to.Ptr[int32](2),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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 { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Validate information for a certificate order.
 *
 * @summary Description for Validate information for a certificate order.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json
 */
async function validateAppServiceCertificatePurchaseInformationBySubscription() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const appServiceCertificateOrder = {
    autoRenew: true,
    certificates: {
      sampleCertName1: {
        keyVaultId:
          "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        keyVaultSecretName: "SampleSecretName1",
      },
      sampleCertName2: {
        keyVaultId:
          "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        keyVaultSecretName: "SampleSecretName2",
      },
    },
    distinguishedName: "CN=SampleCustomDomain.com",
    keySize: 2048,
    location: "Global",
    productType: "StandardDomainValidatedSsl",
    validityInYears: 2,
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceCertificateOrders.validatePurchaseInformation(
    appServiceCertificateOrder,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json
// this example is just showing the usage of "AppServiceCertificateOrders_ValidatePurchaseInformation" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AppServiceCertificateOrderData data = new AppServiceCertificateOrderData(new AzureLocation("Global"))
{
    Certificates =
    {
    ["SampleCertName1"] = new AppServiceCertificateProperties()
    {
    KeyVaultId = new ResourceIdentifier("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName"),
    KeyVaultSecretName = "SampleSecretName1",
    },
    ["SampleCertName2"] = new AppServiceCertificateProperties()
    {
    KeyVaultId = new ResourceIdentifier("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName"),
    KeyVaultSecretName = "SampleSecretName2",
    },
    },
    DistinguishedName = "CN=SampleCustomDomain.com",
    ValidityInYears = 2,
    KeySize = 2048,
    ProductType = CertificateProductType.StandardDomainValidatedSsl,
    IsAutoRenew = true,
};
await subscriptionResource.ValidateAppServiceCertificateOrderPurchaseInformationAsync(data);

Console.WriteLine("Succeeded");

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

応答のサンプル

状態コード:

204

定義

名前	説明
AppServiceCertificate	Azure 経由で購入された証明書の Key Vault コンテナー。
AppServiceCertificateOrder	SSL 証明書の発注書。
CertificateDetails	SSL 証明書の詳細。
CertificateOrderContact
CertificateOrderStatus	現在の注文の状態。
CertificateProductType	証明書製品の種類。
DefaultErrorResponse	App Service エラー応答。
Details
Error	エラー モデル。
KeyVaultSecretStatus	Key Vault シークレットの状態。
ProvisioningState	証明書の注文の状態。
ResourceNotRenewableReason	現時点で App Service 証明書が更新できない理由。

AppServiceCertificate

Object

Azure 経由で購入された証明書の Key Vault コンテナー。

名前	型	説明
keyVaultId	string	Key Vault リソース ID。
keyVaultSecretName	string	Key Vault シークレット名。
provisioningState	KeyVaultSecretStatus	Key Vault シークレットの状態。

AppServiceCertificateOrder

Object

SSL 証明書の発注書。

名前	型	規定値	説明
id	string		リソース ID。
kind	string		リソースの種類。 リソースがアプリの場合は、サポートされている種類の値の詳細については、https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference を参照してください。
location	string		リソースの場所。
name	string		リソース名。
properties.appServiceCertificateNotRenewableReasons	ResourceNotRenewableReason[]		現時点で App Service 証明書が更新できない理由。
properties.autoRenew	boolean	True	証明書の有効期限が切れたときに証明書を自動的に更新する必要があるかどうかを true します。それ以外の場合は、falseします。
properties.certificates	<string,  AppServiceCertificate>		Key Vault シークレットの状態。
properties.contact	CertificateOrderContact		連絡先情報
properties.csr	string		この注文に対して作成された最後の CSR。
properties.distinguishedName	string		証明書の識別名。
properties.domainVerificationToken	string		ドメイン検証トークン。
properties.expirationTime	string (date-time)		証明書の有効期限。
properties.intermediate	CertificateDetails		中間証明書。
properties.isPrivateKeyExternal	boolean		秘密キーが外部の場合に true します。それ以外の場合は、falseします。
properties.keySize	integer (int32)	2048	証明書キーのサイズ。
properties.lastCertificateIssuanceTime	string (date-time)		証明書の最終発行時刻。
properties.nextAutoRenewalTimeStamp	string (date-time)		次に証明書が自動更新されるタイムスタンプ
properties.productType	CertificateProductType		証明書製品の種類。
properties.provisioningState	ProvisioningState		証明書の注文の状態。
properties.root	CertificateDetails		ルート証明書。
properties.serialNumber	string		証明書の現在のシリアル番号。
properties.signedCertificate	CertificateDetails		署名された証明書。
properties.status	CertificateOrderStatus		現在の注文の状態。
properties.validityInYears	integer (int32)	1	年単位の期間 (1 にする必要があります)。
tags	object		リソース タグ。
type	string		リソースの種類。

CertificateDetails

Object

SSL 証明書の詳細。

名前	型	説明
issuer	string	証明書発行者。
notAfter	string (date-time)	日付証明書が有効です。
notBefore	string (date-time)	Date Certificate is valid from.
rawData	string	生の証明書データ。
serialNumber	string	証明書のシリアル番号。
signatureAlgorithm	string	証明書署名アルゴリズム。
subject	string	証明書のサブジェクト。
thumbprint	string	証明書の拇印。
version	integer (int32)	証明書のバージョン。

CertificateOrderContact

Object

名前	型	説明
email	string
nameFirst	string
nameLast	string
phone	string

CertificateOrderStatus

列挙

現在の注文の状態。

値	説明
Canceled
Denied
Expired
Issued
NotSubmitted
PendingRekey
Pendingissuance
Pendingrevocation
Revoked
Unused

CertificateProductType

列挙

証明書製品の種類。

値	説明
StandardDomainValidatedSsl
StandardDomainValidatedWildCardSsl

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラー モデル。

Details

Object

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

Object

エラー モデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグ エラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

KeyVaultSecretStatus

列挙

Key Vault シークレットの状態。

値	説明
AzureServiceUnauthorizedToAccessKeyVault
CertificateOrderFailed
ExternalPrivateKey
Initialized
KeyVaultDoesNotExist
KeyVaultSecretDoesNotExist
OperationNotPermittedOnKeyVault
Succeeded
Unknown
UnknownError
WaitingOnCertificateOrder

ProvisioningState

列挙

証明書の注文の状態。

値	説明
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

列挙

現時点で App Service 証明書が更新できない理由。

値	説明
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive