Site Certificates - Update Slot

Referenz

Dienst:: App Service

API-Version:: 2024-11-01

Erstellen oder aktualisieren Sie ein Zertifikat für einen Standort und einen Bereitstellungsslot.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
certificateName	path	True	string	Name des Zertifikats.
name	path	True	string	Name der Website.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
slot	path	True	string	Name des Bereitstellungsplatzes. Wenn kein Steckplatz angegeben ist, erstellt die API eine Bindung für den Produktionsplatz.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
kind	string	Art der Ressource.
properties.canonicalName	string	CNAME des Zertifikats, das über ein kostenloses Zertifikat ausgestellt werden soll
properties.domainValidationMethod	string	Methode der Domänenüberprüfung für kostenloses Zertifikat
properties.hostNames	string[]	Hostnamen, für die das Zertifikat gilt.
properties.keyVaultId	string	Key Vault Csm-Ressourcen-ID.
properties.keyVaultSecretName	string	Schlüsseltresorschlüsselname.
properties.password	string	Zertifikatkennwort.
properties.pfxBlob	string (byte)	Pfx-BLOB.
properties.serverFarmId	string	Ressourcen-ID des zugeordneten App Service-Plans, formatiert als "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Antworten

Name	Typ	Beschreibung
200 OK	Certificate	OKAY.
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Patch Certificate for slot

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

{
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.KeyVault/vaults/testKV"
  }
}

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.AppService;

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

// invoke the operation
AppCertificatePatch patch = new AppCertificatePatch
{
    KeyVaultId = new ResourceIdentifier("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.KeyVault/vaults/testKV"),
};
SiteSlotCertificateResource result = await siteSlotCertificate.UpdateAsync(patch);

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testSiteName/slots/staging/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",
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.KeyVault/vaults/testKV"
  }
}

Definitionen

Name	Beschreibung
Certificate	SSL-Zertifikat für eine App.
CertificatePatchResource	ARM-Ressource für ein Zertifikat.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
HostingEnvironmentProfile	Spezifikation für eine App Service-Umgebung, die für diese Ressource verwendet werden soll.
KeyVaultSecretStatus	Status des Schlüsseltresorschlüssels.

Certificate

Objekt

SSL-Zertifikat für eine App.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource. Wenn es sich bei der Ressource um eine App handelt, können Sie auf https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference für details unterstützte Werte für die Art verweisen.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.canonicalName	string	CNAME des Zertifikats, das über ein kostenloses Zertifikat ausgestellt werden soll
properties.cerBlob	string (byte)	Unformatierte Bytes .cer Datei
properties.domainValidationMethod	string	Methode der Domänenüberprüfung für kostenloses Zertifikat
properties.expirationDate	string (date-time)	Ablaufdatum des Zertifikats.
properties.friendlyName	string	Anzeigename des Zertifikats.
properties.hostNames	string[]	Hostnamen, für die das Zertifikat gilt.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Spezifikation für die App-Dienstumgebung, die für das Zertifikat verwendet werden soll.
properties.issueDate	string (date-time)	Zertifikatproblemdatum.
properties.issuer	string	Zertifikataussteller.
properties.keyVaultId	string (arm-id)	Azure Key Vault-CSM-Ressourcen-ID.
properties.keyVaultSecretName	string	Geheimer Azure Key Vault-Name.
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Status des Schlüsseltresorschlüssels.
properties.password	string	Zertifikatkennwort.
properties.pfxBlob	string (byte)	Pfx-BLOB.
properties.publicKeyHash	string	Hash für öffentliche Schlüssel.
properties.selfLink	string	Selbstlink.
properties.serverFarmId	string (arm-id)	Ressourcen-ID des zugeordneten App Service-Plans.
properties.siteName	string	App-Name.
properties.subjectName	string	Antragstellername des Zertifikats.
properties.thumbprint	string	Zertifikatfingerabdruck.
properties.valid	boolean	Ist das Zertifikat gültig?.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

CertificatePatchResource

Objekt

ARM-Ressource für ein Zertifikat.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.canonicalName	string	CNAME des Zertifikats, das über ein kostenloses Zertifikat ausgestellt werden soll
properties.cerBlob	string (byte)	Unformatierte Bytes .cer Datei
properties.domainValidationMethod	string	Methode der Domänenüberprüfung für kostenloses Zertifikat
properties.expirationDate	string (date-time)	Ablaufdatum des Zertifikats.
properties.friendlyName	string	Anzeigename des Zertifikats.
properties.hostNames	string[]	Hostnamen, für die das Zertifikat gilt.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Spezifikation für die App-Dienstumgebung, die für das Zertifikat verwendet werden soll.
properties.issueDate	string (date-time)	Zertifikatproblemdatum.
properties.issuer	string	Zertifikataussteller.
properties.keyVaultId	string	Key Vault Csm-Ressourcen-ID.
properties.keyVaultSecretName	string	Schlüsseltresorschlüsselname.
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Status des Schlüsseltresorschlüssels.
properties.password	string	Zertifikatkennwort.
properties.pfxBlob	string (byte)	Pfx-BLOB.
properties.publicKeyHash	string	Hash für öffentliche Schlüssel.
properties.selfLink	string	Selbstlink.
properties.serverFarmId	string	Ressourcen-ID des zugeordneten App Service-Plans, formatiert als "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
properties.siteName	string	App-Name.
properties.subjectName	string	Antragstellername des Zertifikats.
properties.thumbprint	string	Zertifikatfingerabdruck.
properties.valid	boolean	Ist das Zertifikat gültig?.
type	string	Ressourcentyp.

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

HostingEnvironmentProfile

Objekt

Spezifikation für eine App Service-Umgebung, die für diese Ressource verwendet werden soll.

Name	Typ	Beschreibung
id	string	Ressourcen-ID der App-Dienstumgebung.
name	string	Name der App-Dienstumgebung.
type	string	Ressourcentyp der App-Dienstumgebung.

KeyVaultSecretStatus

Enumeration

Status des Schlüsseltresorschlüssels.

Wert	Beschreibung
AzureServiceUnauthorizedToAccessKeyVault
CertificateOrderFailed
ExternalPrivateKey
Initialized
KeyVaultDoesNotExist
KeyVaultSecretDoesNotExist
OperationNotPermittedOnKeyVault
Succeeded
Unknown
UnknownError
WaitingOnCertificateOrder

Freigeben über

Site Certificates - Update Slot

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Patch Certificate for slot

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Certificate

CertificatePatchResource

DefaultErrorResponse

Details

Error

HostingEnvironmentProfile

KeyVaultSecretStatus