Ca Certificates - Get

Referência

Serviço:: Event Grid

Versão da API:: 2025-02-15

Obtenha um certificado de autoridade de certificação.
Obter propriedades de um certificado de autoridade de certificação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
caCertificateName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	Nome do certificado de autoridade de certificação.
namespaceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	Nome do namespace.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	CaCertificate	OKEY
Other Status Codes	ErrorResponse	Resposta de erro retornada se a solicitação não tiver sido bem-sucedida.

Exemplos

CaCertificates_Get

Solicitação de exemplo

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


/**
 * Samples for CaCertificates Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/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

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/stable/2025-02-15/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

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/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/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

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * 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/stable/2025-02-15/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

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_Get.json
// this example is just showing the usage of "CaCertificates_Get" 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";
NullableResponse<CaCertificateResource> response = await collection.GetIfExistsAsync(caCertificateName);
CaCertificateResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
CaCertificate	O recurso certificado de autoridade de certificação.
CaCertificateProvisioningState	Estado de provisionamento do recurso certificado de AC.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e última modificação do recurso.

CaCertificate

Objeto

O recurso certificado de autoridade de certificação.

Nome	Tipo	Description
id	string	Identificador totalmente qualificado do recurso.
name	string	Nome do recurso.
properties.description	string	Descrição para o recurso de Certificado de Autoridade de Certificação.
properties.encodedCertificate	string	Dados de certificado de formato PEM codificado em Base64 (Email Avançado de Privacidade).
properties.expiryTimeInUtc	string (date-time)	Hora de expiração do certificado em UTC. Este é um campo somente leitura.
properties.issueTimeInUtc	string (date-time)	Hora do problema do certificado em UTC. Este é um campo somente leitura.
properties.provisioningState	CaCertificateProvisioningState	Estado de provisionamento do recurso certificado de AC.
systemData	systemData	Os metadados do sistema relacionados ao recurso da Grade de Eventos.
type	string	Tipo do recurso.

CaCertificateProvisioningState

Enumeração

Estado de provisionamento do recurso certificado de AC.

Valor	Description
Canceled
Creating
Deleted
Deleting
Failed
Succeeded
Updating

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.