Site Certificates - Create Or Update

Usługa:

App Service

Wersja interfejsu API:

2024-11-01

Tworzenie lub aktualizowanie certyfikatu w ramach danej lokacji.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}?api-version=2024-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
certificateName	path	True	string	Nazwa certyfikatu.
name	path	True	string pattern: ^[A-z][A-z0-9]*$	Nazwa witryny.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
kind		string	Rodzaj zasobu. Jeśli zasób jest aplikacją, możesz zapoznać się z https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference, aby uzyskać szczegółowe informacje o obsługiwanych wartościach dla rodzaju.
properties.canonicalName		string	CNAME certyfikatu do wystawienia za pośrednictwem bezpłatnego certyfikatu
properties.domainValidationMethod		string	Metoda weryfikacji domeny dla bezpłatnego certyfikatu
properties.hostNames		string[]	Nazwy hostów, do których ma zastosowanie certyfikat.
properties.keyVaultId		string (arm-id)	Identyfikator zasobu Csm usługi Azure Key Vault.
properties.keyVaultSecretName		string	Nazwa wpisu tajnego usługi Azure Key Vault.
properties.password		string	Hasło certyfikatu.
properties.pfxBlob		string (byte)	Obiekt blob Pfx.
properties.serverFarmId		string (arm-id)	Identyfikator zasobu skojarzonego planu App Service.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Certificate	OK.
201 Created	Certificate	OK.
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create Or Update Certificate

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testSiteName/certificates/testc6282?api-version=2024-11-01

{
  "location": "East US",
  "properties": {
    "hostNames": [
      "ServerCert"
    ],
    "password": "<password>"
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.CertificateInner;
import java.util.Arrays;

/**
 * Samples for SiteCertificates CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateSiteCertificate.json
     */
    /**
     * Sample code: Create Or Update Certificate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateCertificate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getSiteCertificates().createOrUpdateWithResponse("testrg123",
            "testSiteName", "testc6282", new CertificateInner().withLocation("East US")
                .withPassword("fakeTokenPlaceholder").withHostNames(Arrays.asList("ServerCert")),
            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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python create_or_update_site_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.site_certificates.create_or_update(
        resource_group_name="testrg123",
        name="testSiteName",
        certificate_name="testc6282",
        certificate_envelope={
            "location": "East US",
            "properties": {"hostNames": ["ServerCert"], "password": "<password>"},
        },
    )
    print(response)


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

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateSiteCertificate.json
func ExampleSiteCertificatesClient_CreateOrUpdate() {
	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.NewSiteCertificatesClient().CreateOrUpdate(ctx, "testrg123", "testSiteName", "testc6282", armappservice.AppCertificate{
		Location: to.Ptr("East US"),
		Properties: &armappservice.AppCertificateProperties{
			HostNames: []*string{
				to.Ptr("ServerCert")},
			Password: to.Ptr("<password>"),
		},
	}, 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/sites/certificates"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testSiteName/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

JavaScript

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

/**
 * This sample demonstrates how to Create or update a certificate under a given site.
 *
 * @summary Create or update a certificate under a given site.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateSiteCertificate.json
 */
async function createOrUpdateCertificate() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testSiteName";
  const certificateName = "testc6282";
  const certificateEnvelope = {
    hostNames: ["ServerCert"],
    location: "East US",
    password: "<password>",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.siteCertificates.createOrUpdate(
    resourceGroupName,
    name,
    certificateName,
    certificateEnvelope,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateSiteCertificate.json
// this example is just showing the usage of "SiteCertificates_CreateOrUpdate" 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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testSiteName";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// get the collection of this SiteCertificateResource
SiteCertificateCollection collection = webSite.GetSiteCertificates();

// invoke the operation
string certificateName = "testc6282";
AppCertificateData data = new AppCertificateData(new AzureLocation("East US"))
{
    Password = "<password>",
    HostNames = { "ServerCert" },
};
ArmOperation<SiteCertificateResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, certificateName, data);
SiteCertificateResource result = lro.Value;

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testSiteName/certificates/testc6282",
  "name": "testc6282",
  "type": "Microsoft.Web/sites/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"
  }
}

Kod stanu:

201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testSiteName/certificates/testc6282",
  "name": "testc6282",
  "type": "Microsoft.Web/sites/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"
  }
}

Definicje

Nazwa	Opis
Certificate	Certyfikat SSL dla aplikacji.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
HostingEnvironmentProfile	Specyfikacja środowiska App Service Environment do użycia dla tego zasobu.
KeyVaultSecretStatus	Stan wpisu tajnego usługi Key Vault.

Certificate

Objekt

Certyfikat SSL dla aplikacji.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu. Jeśli zasób jest aplikacją, możesz zapoznać się z https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference, aby uzyskać szczegółowe informacje o obsługiwanych wartościach dla rodzaju.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.canonicalName	string	CNAME certyfikatu do wystawienia za pośrednictwem bezpłatnego certyfikatu
properties.cerBlob	string (byte)	Nieprzetworzone bajty pliku .cer
properties.domainValidationMethod	string	Metoda weryfikacji domeny dla bezpłatnego certyfikatu
properties.expirationDate	string (date-time)	Data wygaśnięcia certyfikatu.
properties.friendlyName	string	Przyjazna nazwa certyfikatu.
properties.hostNames	string[]	Nazwy hostów, do których ma zastosowanie certyfikat.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Specyfikacja środowiska App Service Environment do użycia dla certyfikatu.
properties.issueDate	string (date-time)	Data wystawienia certyfikatu.
properties.issuer	string	Wystawca certyfikatu.
properties.keyVaultId	string (arm-id)	Identyfikator zasobu Csm usługi Azure Key Vault.
properties.keyVaultSecretName	string	Nazwa wpisu tajnego usługi Azure Key Vault.
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Stan wpisu tajnego usługi Key Vault.
properties.password	string	Hasło certyfikatu.
properties.pfxBlob	string (byte)	Obiekt blob Pfx.
properties.publicKeyHash	string	Skrót klucza publicznego.
properties.selfLink	string	Link własny.
properties.serverFarmId	string (arm-id)	Identyfikator zasobu skojarzonego planu App Service.
properties.siteName	string	Nazwa aplikacji.
properties.subjectName	string	Nazwa podmiotu certyfikatu.
properties.thumbprint	string	Odcisk palca certyfikatu.
properties.valid	boolean	Czy certyfikat jest ważny?.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

HostingEnvironmentProfile

Objekt

Specyfikacja środowiska App Service Environment do użycia dla tego zasobu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu środowiska App Service Environment.
name	string	Nazwa środowiska App Service Environment.
type	string	Typ zasobu środowiska App Service Environment.

KeyVaultSecretStatus

Wyliczanie

Stan wpisu tajnego usługi Key Vault.

Wartość	Opis
AzureServiceUnauthorizedToAccessKeyVault
CertificateOrderFailed
ExternalPrivateKey
Initialized
KeyVaultDoesNotExist
KeyVaultSecretDoesNotExist
OperationNotPermittedOnKeyVault
Succeeded
Unknown
UnknownError
WaitingOnCertificateOrder