Certificates - Get

Riferimento

Servizio:: App Service

Versione API:: 2023-12-01

Descrizione per Ottenere un certificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome del certificato.
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene la risorsa. Criterio di espressione regolare: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	L'ID sottoscrizione di Azure. Si tratta di una stringa con formato GUID (ad esempio 00000000000-0000-0000-0000-000000000000000000000).
api-version	query	True	string	Versione API

Risposte

Nome	Tipo	Descrizione
200 OK	Certificate	OK
Other Status Codes	DefaultErrorResponse	servizio app risposta di errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get Certificate

Esempio di richiesta

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282?api-version=2023-12-01


/**
 * Samples for Certificates GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetCertificate.json
     */
    /**
     * Sample code: Get Certificate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getCertificate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getCertificates().getByResourceGroupWithResponse("testrg123",
            "testc6282", 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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_certificate.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.certificates.get(
        resource_group_name="testrg123",
        name="testc6282",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetCertificate.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 armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetCertificate.json
func ExampleCertificatesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificatesClient().Get(ctx, "testrg123", "testc6282", 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.AppCertificate = armappservice.AppCertificate{
	// 	Name: to.Ptr("testc6282"),
	// 	Type: to.Ptr("Microsoft.Web/certificates"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappservice.AppCertificateProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2039-12-31T23:59:59.000Z"); return t}()),
	// 		FriendlyName: to.Ptr(""),
	// 		HostNames: []*string{
	// 			to.Ptr("ServerCert")},
	// 			IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-11-12T23:40:25.000Z"); return t}()),
	// 			Issuer: to.Ptr("CACert"),
	// 			SubjectName: to.Ptr("ServerCert"),
	// 			Thumbprint: to.Ptr("FE703D7411A44163B6D32B3AD9B03E175886EBFE"),
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Description for Get a certificate.
 *
 * @summary Description for Get a certificate.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetCertificate.json
 */
async function getCertificate() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testc6282";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.certificates.get(resourceGroupName, name);
  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.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetCertificate.json
// this example is just showing the usage of "Certificates_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 AppCertificateResource created on azure
// for more information of creating AppCertificateResource, please refer to the document of AppCertificateResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testc6282";
ResourceIdentifier appCertificateResourceId = AppCertificateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppCertificateResource appCertificate = client.GetAppCertificateResource(appCertificateResourceId);

// invoke the operation
AppCertificateResource result = await appCertificate.GetAsync();

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

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282",
  "name": "testc6282",
  "type": "Microsoft.Web/certificates",
  "location": "East US",
  "properties": {
    "friendlyName": "",
    "subjectName": "ServerCert",
    "hostNames": [
      "ServerCert"
    ],
    "issuer": "CACert",
    "issueDate": "2015-11-12T23:40:25+00:00",
    "expirationDate": "2039-12-31T23:59:59+00:00",
    "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE"
  }
}

Definizioni

Nome	Descrizione
Certificate	Certificato SSL per un'app.
DefaultErrorResponse	servizio app risposta di errore.
Details
Error	Modello di errore.
HostingEnvironmentProfile	Specifica per un ambiente del servizio app da usare per questa risorsa.
KeyVaultSecretStatus	Stato del segreto Key Vault.

Certificate

Certificato SSL per un'app.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di risorsa.
location	string	Posizione risorsa.
name	string	Nome risorsa.
properties.canonicalName	string	CNAME del certificato da rilasciare tramite certificato gratuito
properties.cerBlob	string	Byte non elaborati di file di .cer
properties.domainValidationMethod	string	Metodo di convalida del dominio per certificato gratuito
properties.expirationDate	string	Data di scadenza del certificato.
properties.friendlyName	string	Nome descrittivo del certificato.
properties.hostNames	string[]	Nomi host a cui si applica il certificato.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Specifica per l'ambiente del servizio app da usare per il certificato.
properties.issueDate	string	Data del problema del certificato.
properties.issuer	string	Autorità di certificazione.
properties.keyVaultId	string	Key Vault ID risorsa Csm.
properties.keyVaultSecretName	string	Key Vault nome segreto.
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Stato del segreto Key Vault.
properties.password	string	Password del certificato.
properties.pfxBlob	string	BLOB Pfx.
properties.publicKeyHash	string	Hash della chiave pubblica.
properties.selfLink	string	Collegamento automatico.
properties.serverFarmId	string	ID risorsa del piano di servizio app associato, formattato come :"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
properties.siteName	string	Nome dell'app.
properties.subjectName	string	Nome soggetto del certificato.
properties.thumbprint	string	Identificazione personale del certificato.
properties.valid	boolean	Il certificato è valido?.
tags	object	Tag di risorse.
type	string	Tipo di risorsa.

DefaultErrorResponse

servizio app risposta di errore.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare a livello di codice l'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare a livello di codice l'errore.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

HostingEnvironmentProfile

Specifica per un ambiente del servizio app da usare per questa risorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa del ambiente del servizio app.
name	string	Nome della ambiente del servizio app.
type	string	Tipo di risorsa del ambiente del servizio app.

KeyVaultSecretStatus

Stato del segreto Key Vault.

Nome	Tipo	Descrizione
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string