Condividi tramite


Servizio Microsoft.ApiManagement/certificati 2021-12-01-preview

Definizione di risorsa Bicep

Il tipo di risorsa service/certificate può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/certificate, aggiungere il modello Bicep seguente.

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

Valori delle proprietà

service/certificate

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.
stringa (obbligatoria)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.
Nome simbolico per la risorsa di tipo: servizio
properties Dettagli sulle proprietà di creazione o aggiornamento del certificato. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
data Certificato codificato base 64 usando la rappresentazione application/x-pkcs12. string
keyVault Dettagli della posizione di KeyVault del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password Password per il certificato string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrizione Valore
identityClientId Null per SystemAssignedIdentity o Id client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. string
secretIdentifier Identificatore segreto dell'insieme di credenziali delle chiavi per recuperare il segreto. La fornitura di un segreto con versione impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello

Distribuisci in Azure
Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa service/certificate può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/certificate, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

service/certificate

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/certificates'
apiVersion Versione dell'API risorsa '2021-12-01-preview'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.
stringa (obbligatoria)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
properties Dettagli sulle proprietà di creazione o aggiornamento del certificato. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
data Certificato codificato base 64 usando la rappresentazione application/x-pkcs12. string
keyVault Dettagli della posizione di KeyVault del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password Password per il certificato string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrizione Valore
identityClientId Null per SystemAssignedIdentity o Id client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. string
secretIdentifier Identificatore segreto dell'insieme di credenziali delle chiavi per recuperare il segreto. La fornitura di un segreto con versione impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello

Distribuisci in Azure
Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/certificate può essere distribuito con operazioni destinate:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/certificate, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

service/certificate

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/certificates@2021-12-01-preview"
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
properties Dettagli sulle proprietà di creazione o aggiornamento del certificato. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
data Certificato codificato base 64 usando la rappresentazione application/x-pkcs12. string
keyVault Dettagli della posizione di KeyVault del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
password Password per il certificato string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrizione Valore
identityClientId Null per SystemAssignedIdentity o Id client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. string
secretIdentifier Identificatore segreto dell'insieme di credenziali delle chiavi per recuperare il segreto. La fornitura di un segreto con versione impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi string