Ca Certificates - Create Or Update

Referenz

Service:: Event Grid

API Version:: 2024-06-01-preview

Create oder aktualisieren Sie ein Zertifizierungsstellenzertifikat mit den angegebenen Parametern.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
caCertificateName	path	True	string	Der Name des Zertifizierungsstellenzertifikats. Regex pattern: `^[a-zA-Z0-9-]*$`
namespaceName	path	True	string	Name des Namespace. Regex pattern: `^[a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe im Abonnement des Benutzers.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.description	string	Beschreibung für die Zertifizierungsstellenzertifikatressource.
properties.encodedCertificate	string	Base64-codierte PEM-Zertifikatdaten (Privacy Enhanced Mail)

Antworten

Name	Typ	Beschreibung
200 OK	CaCertificate	Create- oder Updateanforderung ist erfolgreich.
201 Created	CaCertificate	Erstellt
Other Status Codes	ErrorResponse	Fehlerantwort zurückgegeben, wenn die Anforderung nicht erfolgreich war.

Beispiele

CaCertificates_CreateOrUpdate

Sample Request

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


/**
 * 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

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

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

Status code:: 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"
}

Definitionen

Name	Beschreibung
CaCertificate	Die Zertifizierungsstellenzertifikatressource.
CaCertificateProvisioningState	Bereitstellungsstatus der Zertifizierungsstellenzertifikatressource.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CaCertificate

Die Zertifizierungsstellenzertifikatressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Ressource.
name	string	Der Name der Ressource.
properties.description	string	Beschreibung für die Zertifizierungsstellenzertifikatressource.
properties.encodedCertificate	string	Base64-codierte PEM-Zertifikatdaten (Privacy Enhanced Mail)
properties.expiryTimeInUtc	string	Ablaufzeit des Zertifikats in UTC. Dieses Feld ist schreibgeschützt.
properties.issueTimeInUtc	string	Zertifikatausgabezeit in UTC. Dieses Feld ist schreibgeschützt.
properties.provisioningState	CaCertificateProvisioningState	Bereitstellungsstatus der Zertifizierungsstellenzertifikatressource.
systemData	systemData	Die Systemmetadaten im Zusammenhang mit der CaCertificate-Ressource.
type	string	Der Typ der Ressource.

CaCertificateProvisioningState

Bereitstellungsstatus der Zertifizierungsstellenzertifikatressource.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über