Certificates - List

Referenz

Dienst:: Azure Spring Apps

API-Version:: 2023-12-01

Listet alle Zertifikate eines Benutzers auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates?api-version=2023-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serviceName	path	True	string	Der Name der Dienstressource. RegEx-Muster: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Ruft die Abonnement-ID ab, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	CertificateResourceCollection	Erfolg. Die Antwort beschreibt die Liste der Zertifikate im Dienst.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Certificates_List

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates?api-version=2023-12-01


/**
 * Samples for Certificates List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_List.
     * json
     */
    /**
     * Sample code: Certificates_List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void certificatesList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getCertificates().list("myResourceGroup", "myservice",
            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.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python certificates_list.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 = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.certificates.list(
        resource_group_name="myResourceGroup",
        service_name="myservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_List.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 armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_List.json
func ExampleCertificatesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCertificatesClient().NewListPager("myResourceGroup", "myservice", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CertificateResourceCollection = armappplatform.CertificateResourceCollection{
		// 	Value: []*armappplatform.CertificateResource{
		// 		{
		// 			Name: to.Ptr("mycertificate"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/certificates"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate"),
		// 			SystemData: &armappplatform.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
		// 				CreatedBy: to.Ptr("sample-user"),
		// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("sample-user"),
		// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armappplatform.KeyVaultCertificateProperties{
		// 				Type: to.Ptr("KeyVaultCertificate"),
		// 				ActivateDate: to.Ptr("2019-02-22T07:40:42Z"),
		// 				DNSNames: []*string{
		// 					to.Ptr("mydomain.com"),
		// 					to.Ptr("mydomain.net"),
		// 					to.Ptr("mydomain.io")},
		// 					ExpirationDate: to.Ptr("2019-02-21T07:40:42Z"),
		// 					IssuedDate: to.Ptr("2019-02-20T07:40:42Z"),
		// 					Issuer: to.Ptr("mydomain.com"),
		// 					ProvisioningState: to.Ptr(armappplatform.CertificateResourceProvisioningStateSucceeded),
		// 					SubjectName: to.Ptr("mysubjectname"),
		// 					Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
		// 					AutoSync: to.Ptr(armappplatform.KeyVaultCertificateAutoSyncDisabled),
		// 					CertVersion: to.Ptr("08a219d06d874795a96db47e06fbb01e"),
		// 					ExcludePrivateKey: to.Ptr(false),
		// 					KeyVaultCertName: to.Ptr("mycert"),
		// 					VaultURI: to.Ptr("https://myvault.vault.azure.net"),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all the certificates of one user.
 *
 * @summary List all the certificates of one user.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_List.json
 */
async function certificatesList() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.certificates.list(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "properties": {
        "type": "KeyVaultCertificate",
        "excludePrivateKey": false,
        "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
        "vaultUri": "https://myvault.vault.azure.net",
        "keyVaultCertName": "mycert",
        "certVersion": "08a219d06d874795a96db47e06fbb01e",
        "issuer": "mydomain.com",
        "issuedDate": "2019-02-20T07:40:42Z",
        "expirationDate": "2019-02-21T07:40:42Z",
        "activateDate": "2019-02-22T07:40:42Z",
        "subjectName": "mysubjectname",
        "dnsNames": [
          "mydomain.com",
          "mydomain.net",
          "mydomain.io"
        ],
        "autoSync": "Disabled",
        "provisioningState": "Succeeded"
      },
      "systemData": {
        "createdBy": "sample-user",
        "createdByType": "User",
        "createdAt": "2021-08-11T03:16:03.944Z",
        "lastModifiedBy": "sample-user",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-11T03:17:03.944Z"
      },
      "type": "Microsoft.AppPlatform/Spring/certificates",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate",
      "name": "mycertificate"
    }
  ],
  "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates?$page=2"
}

Definitionen

Name	Beschreibung
CertificateResource	Zertifikatressourcennutzlast.
CertificateResourceCollection	Sammlungssammlung der Liste der Zertifikatressourcen und ein möglicher Link für die nächste Seite.
CertificateResourceProvisioningState	Bereitstellungsstatus des Zertifikats
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
ContentCertificateProperties	Eigenschaften des aus dem Schlüsseltresor importierten Zertifikats.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
KeyVaultCertificateAutoSync	Gibt an, ob das Zertifikat aus dem Schlüsseltresor automatisch synchronisiert werden soll.
KeyVaultCertificateProperties	Eigenschaften des aus dem Schlüsseltresor importierten Zertifikats.
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CertificateResource

Zertifikatressourcennutzlast.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource.
name	string	Der Name der Ressource.
properties	CertificateProperties: ContentCertificateProperties KeyVaultCertificateProperties	Eigenschaften der Zertifikatressourcennutzlast.
systemData	SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type	string	Der Typ der Ressource.

CertificateResourceCollection

Sammlungssammlung der Liste der Zertifikatressourcen und ein möglicher Link für die nächste Seite.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite der Zertifikatliste.
value	CertificateResource[]	Die Liste der Zertifikatressourcen.

CertificateResourceProvisioningState

Bereitstellungsstatus des Zertifikats

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

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

ContentCertificateProperties

Eigenschaften des aus dem Schlüsseltresor importierten Zertifikats.

Name	Typ	Beschreibung
activateDate	string	Das Aktivierungsdatum des Zertifikats.
content	string	Der Inhalt des hochgeladenen Zertifikats.
dnsNames	string[]	Die Domänenliste des Zertifikats.
expirationDate	string	Das Ablaufdatum des Zertifikats.
issuedDate	string	Das Ausstellungsdatum des Zertifikats.
issuer	string	Der Aussteller des Zertifikats.
provisioningState	CertificateResourceProvisioningState	Bereitstellungsstatus des Zertifikats
subjectName	string	Der Antragstellername des Zertifikats.
thumbprint	string	Der Fingerabdruck des Zertifikats.
type	string: ContentCertificate	Der Typ der Zertifikatquelle.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

KeyVaultCertificateAutoSync

Gibt an, ob das Zertifikat aus dem Schlüsseltresor automatisch synchronisiert werden soll.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

KeyVaultCertificateProperties

Eigenschaften des aus dem Schlüsseltresor importierten Zertifikats.

Name	Typ	Standardwert	Beschreibung
activateDate	string		Das Aktivierungsdatum des Zertifikats.
autoSync	KeyVaultCertificateAutoSync	Disabled	Gibt an, ob das Zertifikat aus dem Schlüsseltresor automatisch synchronisiert werden soll.
certVersion	string		Die Zertifikatversion des Schlüsseltresors.
dnsNames	string[]		Die Domänenliste des Zertifikats.
excludePrivateKey	boolean	False	Optional. Wenn dieser Wert auf TRUE festgelegt ist, wird kein privater Schlüssel aus dem Schlüsseltresor importiert.
expirationDate	string		Das Ablaufdatum des Zertifikats.
issuedDate	string		Das Ausstellungsdatum des Zertifikats.
issuer	string		Der Aussteller des Zertifikats.
keyVaultCertName	string		Der Zertifikatname des Schlüsseltresors.
provisioningState	CertificateResourceProvisioningState		Bereitstellungsstatus des Zertifikats
subjectName	string		Der Antragstellername des Zertifikats.
thumbprint	string		Der Fingerabdruck des Zertifikats.
type	string: KeyVaultCertificate		Der Typ der Zertifikatquelle.
vaultUri	string		Der Tresor-URI des Benutzerschlüsseltresors.

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

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 Ressourcenänderung (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Certificates - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Certificates_List

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CertificateResource

CertificateResourceCollection

CertificateResourceProvisioningState

CloudError

CloudErrorBody

ContentCertificateProperties

createdByType

KeyVaultCertificateAutoSync

KeyVaultCertificateProperties

lastModifiedByType

SystemData

Zusätzliche Ressourcen