Freigeben über


Microsoft.ApiManagement-Dienst/Zertifikate 2022-09-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp "Dienst/Zertifikate" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2022-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Eigenschaftswerte

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Name Beschreibung Wert
Daten Base64-codiertes Zertifikat mit der Anwendungs-/x-pkcs12-Darstellung. Schnur
keyVault KeyVault-Standortdetails des Zertifikats. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
Passwort Kennwort für das Zertifikat Schnur

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Name Beschreibung Wert
identityClientId Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. Schnur
secretIdentifier Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. Schnur

Microsoft.ApiManagement/service/certificates

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Elternteil 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 des Typs: Dienst-
Eigenschaften Details zum Erstellen oder Aktualisieren von Zertifikateigenschaften. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Dienst/Zertifikate" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

Eigenschaftswerte

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Name Beschreibung Wert
Daten Base64-codiertes Zertifikat mit der Anwendungs-/x-pkcs12-Darstellung. Schnur
keyVault KeyVault-Standortdetails des Zertifikats. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
Passwort Kennwort für das Zertifikat Schnur

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Name Beschreibung Wert
identityClientId Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. Schnur
secretIdentifier Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. Schnur

Microsoft.ApiManagement/service/certificates

Name Beschreibung Wert
apiVersion Die API-Version "2022-09-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften Details zum Erstellen oder Aktualisieren von Zertifikateigenschaften. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/certificates"

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 unter Änderungsprotokoll.

Ressourcenformat

Um eine Ressource "Microsoft.ApiManagement/service/certificates" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2022-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Eigenschaftswerte

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Name Beschreibung Wert
Daten Base64-codiertes Zertifikat mit der Anwendungs-/x-pkcs12-Darstellung. Schnur
keyVault KeyVault-Standortdetails des Zertifikats. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
Passwort Kennwort für das Zertifikat Schnur

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Name Beschreibung Wert
identityClientId Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. Schnur
secretIdentifier Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. Schnur

Microsoft.ApiManagement/service/certificates

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Details zum Erstellen oder Aktualisieren von Zertifikateigenschaften. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/certificates@2022-09-01-preview"