Condividi tramite

Servizio Microsoft.ApiManagement/portalconfigs 2023-03-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/portalconfigs 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/portalconfigs, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/portalconfigs

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
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à Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties

PortalConfigCorsProperties

Nome Descrizione Valore
allowedOrigins Origini consentite, ad esempio https://trusted.com. string[]

PortalConfigCspProperties

Nome Descrizione Valore
allowedSources Origini consentite, ad esempio *.trusted.com, trusted.com, https://. string[]
modo Modalità dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori. 'disabled'
'enabled'
'reportOnly'
reportUri URL usati dal browser per segnalare violazioni CSP. string[]

PortalConfigDelegationProperties

Nome Descrizione Valore
delegateRegistration Abilitare o disabilitare la delega per la registrazione dell'utente. Bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni di prodotti. Bool
delegationUrl URL dell'endpoint di delega. corda
validationKey Chiave di convalida con codifica Base64 per garantire che le richieste provengano dal servizio Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalConfigProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori. PortalConfigCorsProperties
Csp Impostazioni CSP (Content Security Policy) del portale per sviluppatori. PortalConfigCspProperties
delegazione Impostazioni di delega del portale per sviluppatori. PortalConfigDelegationProperties
enableBasicAuth Abilitare o disabilitare il metodo di autenticazione di base. Bool
signin PortalConfigPropertiesSignin
iscrizione PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome Descrizione Valore
richiedere Reindirizzare utenti anonimi alla pagina di accesso. Bool

PortalConfigPropertiesSignup

Nome Descrizione Valore
termsOfService Impostazioni delle condizioni per il servizio. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome Descrizione Valore
requireConsent Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Testo Testo relativo alle condizioni per il servizio. corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/portalconfigs 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/portalconfigs, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/portalconfigs

Nome Descrizione Valore
apiVersion Versione dell'API '2023-03-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
proprietà Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/portalconfigs'

PortalConfigCorsProperties

Nome Descrizione Valore
allowedOrigins Origini consentite, ad esempio https://trusted.com. string[]

PortalConfigCspProperties

Nome Descrizione Valore
allowedSources Origini consentite, ad esempio *.trusted.com, trusted.com, https://. string[]
modo Modalità dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori. 'disabled'
'enabled'
'reportOnly'
reportUri URL usati dal browser per segnalare violazioni CSP. string[]

PortalConfigDelegationProperties

Nome Descrizione Valore
delegateRegistration Abilitare o disabilitare la delega per la registrazione dell'utente. Bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni di prodotti. Bool
delegationUrl URL dell'endpoint di delega. corda
validationKey Chiave di convalida con codifica Base64 per garantire che le richieste provengano dal servizio Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalConfigProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori. PortalConfigCorsProperties
Csp Impostazioni CSP (Content Security Policy) del portale per sviluppatori. PortalConfigCspProperties
delegazione Impostazioni di delega del portale per sviluppatori. PortalConfigDelegationProperties
enableBasicAuth Abilitare o disabilitare il metodo di autenticazione di base. Bool
signin PortalConfigPropertiesSignin
iscrizione PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome Descrizione Valore
richiedere Reindirizzare utenti anonimi alla pagina di accesso. Bool

PortalConfigPropertiesSignup

Nome Descrizione Valore
termsOfService Impostazioni delle condizioni per il servizio. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome Descrizione Valore
requireConsent Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Testo Testo relativo alle condizioni per il servizio. corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/portalconfigs 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/portalconfigs, aggiungere il comando Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  })
}

Valori delle proprietà

Microsoft.ApiManagement/service/portalconfigs

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/portalconfigs@2023-03-01-preview"

PortalConfigCorsProperties

Nome Descrizione Valore
allowedOrigins Origini consentite, ad esempio https://trusted.com. string[]

PortalConfigCspProperties

Nome Descrizione Valore
allowedSources Origini consentite, ad esempio *.trusted.com, trusted.com, https://. string[]
modo Modalità dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori. 'disabled'
'enabled'
'reportOnly'
reportUri URL usati dal browser per segnalare violazioni CSP. string[]

PortalConfigDelegationProperties

Nome Descrizione Valore
delegateRegistration Abilitare o disabilitare la delega per la registrazione dell'utente. Bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni di prodotti. Bool
delegationUrl URL dell'endpoint di delega. corda
validationKey Chiave di convalida con codifica Base64 per garantire che le richieste provengano dal servizio Gestione API di Azure. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.

PortalConfigProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori. PortalConfigCorsProperties
Csp Impostazioni CSP (Content Security Policy) del portale per sviluppatori. PortalConfigCspProperties
delegazione Impostazioni di delega del portale per sviluppatori. PortalConfigDelegationProperties
enableBasicAuth Abilitare o disabilitare il metodo di autenticazione di base. Bool
signin PortalConfigPropertiesSignin
iscrizione PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Nome Descrizione Valore
richiedere Reindirizzare utenti anonimi alla pagina di accesso. Bool

PortalConfigPropertiesSignup

Nome Descrizione Valore
termsOfService Impostazioni delle condizioni per il servizio. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome Descrizione Valore
requireConsent Chiedere all'utente il consenso alle condizioni per il servizio. Bool
Testo Testo relativo alle condizioni per il servizio. corda