Microsoft.ApiManagement-Dienst/Zertifikate
Bicep-Ressourcendefinition
Der Ressourcentyp Dienst/Zertifikate kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/certificates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Eigenschaftswerte
service/certificates
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: Dienst |
properties | Eigenschaftendetails zum Erstellen oder Aktualisieren von Zertifikaten. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
Name | BESCHREIBUNG | Wert |
---|---|---|
data | Base 64-codiertes Zertifikat mit der Darstellung application/x-pkcs12. | Zeichenfolge |
keyVault | KeyVault-Speicherortdetails des Zertifikats. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
password | Kennwort für das Zertifikat | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | BESCHREIBUNG | Wert |
---|---|---|
identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Geheimnis des Schlüsseltresors verwendet wird. | Zeichenfolge |
secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines versionsbasierten Geheimnisses verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp Dienst/Zertifikate kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/certificates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
Eigenschaftswerte
service/certificates
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/certificates" |
apiVersion | Die Ressourcen-API-Version | '2023-05-01-preview' |
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
properties | Eigenschaftendetails zum Erstellen oder Aktualisieren von Zertifikaten. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
Name | BESCHREIBUNG | Wert |
---|---|---|
data | Base64-codiertes Zertifikat mit der Anwendungs-/x-pkcs12-Darstellung. | Zeichenfolge |
keyVault | KeyVault-Speicherortdetails des Zertifikats. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
password | Kennwort für das Zertifikat | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | BESCHREIBUNG | Wert |
---|---|---|
identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird. | Zeichenfolge |
secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines geheimen Schlüssels mit Versionsangabe verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp Dienst/Zertifikate kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/certificates-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Eigenschaftswerte
service/certificates
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.ApiManagement/service/certificates@2023-05-01-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
properties | Details zur Erstellung oder Aktualisierung von Zertifikateigenschaften. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
Name | BESCHREIBUNG | Wert |
---|---|---|
data | Base64-codiertes Zertifikat mit der Anwendungs-/x-pkcs12-Darstellung. | Zeichenfolge |
keyVault | KeyVault-Speicherortdetails des Zertifikats. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
password | Kennwort für das Zertifikat | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | BESCHREIBUNG | Wert |
---|---|---|
identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird. | Zeichenfolge |
secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines geheimen Schlüssels mit Versionsangabe verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für