Ca Certificates - Create Or Update

서비스:

Event Grid

API 버전:

2024-06-01-preview

지정된 매개 변수를 사용하여 CA 인증서를 Create 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}?api-version=2024-06-01-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
caCertificateName	path	True	string	CA 인증서 이름입니다. regex 패턴: ^[a-zA-Z0-9-]*$
namespaceName	path	True	string	네임스페이스의 이름입니다. regex 패턴: ^[a-zA-Z0-9-]*$
resourceGroupName	path	True	string	사용자의 구독 내에서 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 본문

Name	형식	Description
properties.description	string	CA 인증서 리소스에 대한 설명입니다.
properties.encodedCertificate	string	Base64로 인코딩된 PEM(개인 정보 보호 강화 메일) 형식 인증서 데이터입니다.

응답

Name	형식	Description
200 OK	CaCertificate	Create 또는 업데이트 요청이 성공했습니다.
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=2024-06-01-preview

{
  "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/preview/2024-06-01-preview/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 typing import Any, IO, Union

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/preview/2024-06-01-preview/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/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/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");

/**
 * 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/preview/2024-06-01-preview/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/preview/2024-06-01-preview/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"
}

정의

Name	Description
CaCertificate	CA 인증서 리소스입니다.
CaCertificateProvisioningState	CA 인증서 리소스의 프로비전 상태입니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

CaCertificate

CA 인증서 리소스입니다.

Name	형식	Description
id	string	리소스의 정규화된 식별자입니다.
name	string	리소스의 이름입니다.
properties.description	string	CA 인증서 리소스에 대한 설명입니다.
properties.encodedCertificate	string	Base64로 인코딩된 PEM(개인 정보 보호 강화 메일) 형식 인증서 데이터입니다.
properties.expiryTimeInUtc	string	인증서 만료 시간(UTC)입니다. 이 필드는 읽기 전용 필드입니다.
properties.issueTimeInUtc	string	인증서 발급 시간(UTC)입니다. 이 필드는 읽기 전용 필드입니다.
properties.provisioningState	CaCertificateProvisioningState	CA 인증서 리소스의 프로비전 상태입니다.
systemData	systemData	CaCertificate 리소스와 관련된 시스템 메타데이터입니다.
type	string	리소스 유형입니다.

CaCertificateProvisioningState

CA 인증서 리소스의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.