Condividi tramite

Servizio Microsoft.ApiManagement/certificates

  • Articolo

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/certificates, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

service/certificates

Nome Descrizione Valore
nome Nome della risorsa

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

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
genitore 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 all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Dettagli sulle proprietà di creazione o aggiornamento del certificato. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
dati Certificato codificato in base 64 usando la rappresentazione application/x-pkcs12. corda
keyVault Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
parola d’ordine Password per il certificato corda

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda

Modelli di avvio rapido

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

Sagoma Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello

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

Definizione di risorsa del modello di Resource Manager

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

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

Valori delle proprietà

service/certificates

Nome Descrizione Valore
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/certificates'
apiVersion Versione dell'API della risorsa '2023-09-01-preview'
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

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

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
dati Certificato codificato in base 64 usando la rappresentazione application/x-pkcs12. corda
keyVault Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
parola d’ordine Password per il certificato corda

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda

Modelli di avvio rapido

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

Sagoma Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello

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

Definizione di risorsa Terraform (provider AzAPI)

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

  • gruppi di risorse

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

Formato risorsa

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

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

Valori delle proprietà

service/certificates

Nome Descrizione Valore
digitare Tipo di risorsa "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
nome Nome della risorsa stringa (obbligatorio)

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
proprietà Dettagli sulle proprietà di creazione o aggiornamento del certificato. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nome Descrizione Valore
dati Certificato codificato in base 64 usando la rappresentazione application/x-pkcs12. corda
keyVault Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
parola d’ordine Password per il certificato corda

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda