Ca Certificates - Get

Service:

Event Grid

API Version:

2024-06-01-preview

Get a CA certificate.
Get properties of a CA certificate.

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

URI Parameters

Name	In	Required	Type	Description
caCertificateName	path	True	string	Name of the CA certificate. Regex pattern: ^[a-zA-Z0-9-]*$
namespaceName	path	True	string	Name of the namespace. Regex pattern: ^[a-zA-Z0-9-]*$
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	CaCertificate	OK
Other Status Codes	ErrorResponse	Error response returned if request was unsuccessful.

Examples

CaCertificates_Get

Sample request

HTTP

GET 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

Java

/**
 * Samples for CaCertificates Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/examples/
     * CaCertificates_Get.json
     */
    /**
     * Sample code: CaCertificates_Get.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void caCertificatesGet(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.caCertificates().getWithResponse("examplerg", "exampleNamespaceName1", "exampleCACertificateName1",
            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.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python ca_certificates_get.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.get(
        resource_group_name="examplerg",
        namespace_name="exampleNamespaceName1",
        ca_certificate_name="exampleCACertificateName1",
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/examples/CaCertificates_Get.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/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_Get.json
func ExampleCaCertificatesClient_Get() {
	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)
	}
	res, err := clientFactory.NewCaCertificatesClient().Get(ctx, "examplerg", "exampleNamespaceName1", "exampleCACertificateName1", 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.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 Get properties of a CA certificate.
 *
 * @summary Get properties of a CA certificate.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/examples/CaCertificates_Get.json
 */
async function caCertificatesGet() {
  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 credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.caCertificates.get(
    resourceGroupName,
    namespaceName,
    caCertificateName,
  );
  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

Sample response

Status code:

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"
}

Definitions

Name	Description
CaCertificate	The CA Certificate resource.
CaCertificateProvisioningState	Provisioning state of the CA Certificate resource.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

CaCertificate

The CA Certificate resource.

Name	Type	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties.description	string	Description for the CA Certificate resource.
properties.encodedCertificate	string	Base64 encoded PEM (Privacy Enhanced Mail) format certificate data.
properties.expiryTimeInUtc	string	Certificate expiry time in UTC. This is a read-only field.
properties.issueTimeInUtc	string	Certificate issue time in UTC. This is a read-only field.
properties.provisioningState	CaCertificateProvisioningState	Provisioning state of the CA Certificate resource.
systemData	systemData	The system metadata relating to the CaCertificate resource.
type	string	Type of the resource.

CaCertificateProvisioningState

Provisioning state of the CA Certificate resource.

Name	Type	Description
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.