Ca Certificates - Create Or Update

サービス:

Event Grid

API バージョン:

2025-02-15

指定したパラメーターを使用して CA 証明書を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}?api-version=2025-02-15

URI パラメーター

名前	/	必須	型	説明
caCertificateName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	CA 証明書名。
namespaceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	名前空間の名前。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント要求で使用する API のバージョン。

要求本文

名前	型	説明
properties.description	string	CA 証明書リソースの説明。
properties.encodedCertificate	string	Base64 でエンコードされた PEM (プライバシー強化メール) 形式の証明書データ。

応答

名前	型	説明
200 OK	CaCertificate	要求の作成または更新が成功しました。
201 Created	CaCertificate	作成
Other Status Codes	ErrorResponse	要求が失敗した場合に返されるエラー応答。

例

CaCertificates_CreateOrUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/caCertificates/exampleCACertificateName1?api-version=2025-02-15

{
  "properties": {
    "description": "This is a test certificate",
    "encodedCertificate": "base64EncodePemFormattedCertificateString"
  }
}

Java

/**
 * Samples for CaCertificates CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/
     * CaCertificates_CreateOrUpdate.json
     */
    /**
     * Sample code: CaCertificates_CreateOrUpdate.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void caCertificatesCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.caCertificates().define("exampleCACertificateName1")
            .withExistingNamespace("examplerg", "exampleNamespaceName1").withDescription("This is a test certificate")
            .withEncodedCertificate("base64EncodePemFormattedCertificateString").create();
    }
}

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.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python ca_certificates_create_or_update.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 = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="8f6b6269-84f2-4d09-9e31-1127efcd1e40",
    )

    response = client.ca_certificates.begin_create_or_update(
        resource_group_name="examplerg",
        namespace_name="exampleNamespaceName1",
        ca_certificate_name="exampleCACertificateName1",
        ca_certificate_info={
            "properties": {
                "description": "This is a test certificate",
                "encodedCertificate": "base64EncodePemFormattedCertificateString",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/CaCertificates_CreateOrUpdate.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 armeventgrid_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/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/CaCertificates_CreateOrUpdate.json
func ExampleCaCertificatesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCaCertificatesClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleNamespaceName1", "exampleCACertificateName1", armeventgrid.CaCertificate{
		Properties: &armeventgrid.CaCertificateProperties{
			Description:        to.Ptr("This is a test certificate"),
			EncodedCertificate: to.Ptr("base64EncodePemFormattedCertificateString"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.CaCertificate = armeventgrid.CaCertificate{
	// 	Name: to.Ptr("exampleCACertificateName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/namespaces/caCertificates"),
	// 	ID: to.Ptr("/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/caCertificates/exampleCACertificateName1"),
	// 	Properties: &armeventgrid.CaCertificateProperties{
	// 		Description: to.Ptr("This is a test Root certificate"),
	// 		EncodedCertificate: to.Ptr("base64EncodePemFormattedCertificateString"),
	// 		ExpiryTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-12T23:06:43.000Z"); return t}()),
	// 		IssueTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T23:06:43.000Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armeventgrid.CaCertificateProvisioningStateSucceeded),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Create or update a CA certificate with the specified parameters.
 *
 * @summary Create or update a CA certificate with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/CaCertificates_CreateOrUpdate.json
 */
async function caCertificatesCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const namespaceName = "exampleNamespaceName1";
  const caCertificateName = "exampleCACertificateName1";
  const caCertificateInfo = {
    description: "This is a test certificate",
    encodedCertificate: "base64EncodePemFormattedCertificateString",
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.caCertificates.beginCreateOrUpdateAndWait(
    resourceGroupName,
    namespaceName,
    caCertificateName,
    caCertificateInfo,
  );
  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.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/CaCertificates_CreateOrUpdate.json
// this example is just showing the usage of "CaCertificates_CreateOrUpdate" 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 EventGridNamespaceResource created on azure
// for more information of creating EventGridNamespaceResource, please refer to the document of EventGridNamespaceResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
string resourceGroupName = "examplerg";
string namespaceName = "exampleNamespaceName1";
ResourceIdentifier eventGridNamespaceResourceId = EventGridNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventGridNamespaceResource eventGridNamespace = client.GetEventGridNamespaceResource(eventGridNamespaceResourceId);

// get the collection of this CaCertificateResource
CaCertificateCollection collection = eventGridNamespace.GetCaCertificates();

// invoke the operation
string caCertificateName = "exampleCACertificateName1";
CaCertificateData data = new CaCertificateData
{
    Description = "This is a test certificate",
    EncodedCertificate = "base64EncodePemFormattedCertificateString",
};
ArmOperation<CaCertificateResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, caCertificateName, data);
CaCertificateResource 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
CaCertificateData 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

{
  "properties": {
    "encodedCertificate": "base64EncodePemFormattedCertificateString",
    "issueTimeInUtc": "2022-09-12T23:06:43+00:00",
    "expiryTimeInUtc": "2022-10-12T23:06:43+00:00",
    "provisioningState": "Succeeded",
    "description": "This is a test Root certificate"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/caCertificates/exampleCACertificateName1",
  "name": "exampleCACertificateName1",
  "type": "Microsoft.EventGrid/namespaces/caCertificates"
}

状態コード:

201

{
  "properties": {
    "encodedCertificate": "base64EncodePemFormattedCertificateString",
    "issueTimeInUtc": "2022-09-12T23:06:43+00:00",
    "expiryTimeInUtc": "2022-10-12T23:06:43+00:00",
    "provisioningState": "Succeeded",
    "description": "This is a test Root certificate"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/caCertificates/exampleCACertificateName1",
  "name": "exampleCACertificateName1",
  "type": "Microsoft.EventGrid/namespaces/caCertificates"
}

定義

名前	説明
CaCertificate	CA 証明書リソース。
CaCertificateProvisioningState	CA 証明書リソースのプロビジョニング状態。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。

CaCertificate

Object

CA 証明書リソース。

名前	型	説明
id	string	リソースの完全修飾識別子。
name	string	リソースの名前。
properties.description	string	CA 証明書リソースの説明。
properties.encodedCertificate	string	Base64 でエンコードされた PEM (プライバシー強化メール) 形式の証明書データ。
properties.expiryTimeInUtc	string (date-time)	証明書の有効期限 (UTC)。 これは読み取り専用フィールドです。
properties.issueTimeInUtc	string (date-time)	証明書の発行時刻 (UTC)。 これは読み取り専用フィールドです。
properties.provisioningState	CaCertificateProvisioningState	CA 証明書リソースのプロビジョニング状態。
systemData	systemData	Event Grid リソースに関連するシステム メタデータ。
type	string	リソースの種類。

CaCertificateProvisioningState

列挙

CA 証明書リソースのプロビジョニング状態。

値	説明
Canceled
Creating
Deleted
Deleting
Failed
Succeeded
Updating

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。