Condividi tramite

Servizio Microsoft.ApiManagement/portalconfigs

  • Articolo

Definizione di risorsa Bicep

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

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/portalconfigs, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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à

service/portalconfigs

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
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 Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties

PortalConfigProperties

Nome Descrizione Valore
CORS Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori. PortalConfigCorsProperties
Csp Impostazioni dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori. PortalConfigCspProperties
delega Impostazioni di delega del portale per sviluppatori. PortalConfigDelegationProperties
enableBasicAuth Abilitare o disabilitare il metodo di autenticazione di base. bool
signin PortalConfigPropertiesSignin
Iscrizione PortalConfigPropertiesSignup

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.comhttps://. string[]
mode 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 utente. bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni di prodotti. bool
delegationUrl URL dell'endpoint di delega. string
Validationkey Una chiave di convalida con codifica Base64 per garantire che le richieste provengano dal servizio azure Gestione API. string

PortalConfigPropertiesSignin

Nome Descrizione Valore
require Reindirizzare gli utenti anonimi alla pagina di accesso. bool

PortalConfigPropertiesSignup

Nome Descrizione Valore
terminiOfService Condizioni per le impostazioni del servizio. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome Descrizione Valore
requireConsent Chiedere all'utente il consenso per le condizioni di servizio. bool
text Termini di testo del servizio. string

Definizione della risorsa modello di Resource Manager

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2023-05-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à

service/portalconfigs

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/portalconfigs'
apiVersion Versione dell'API risorsa '2023-05-01-preview'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.		 stringa (obbligatoria)
properties Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties

PortalConfigProperties

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

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.comhttps://. string[]
mode Modalità del portale per sviluppatori Criteri di sicurezza del contenuto (CSP). 'disabilitato'
'enabled'
'reportOnly'
reportUri URL usati dal browser per segnalare violazioni del provider di servizi di rete. string[]

PortalConfigDelegationProperties

Nome Descrizione Valore
delegateRegistration Abilitare o disabilitare la delega per la registrazione utente. bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni del prodotto. bool
delegaUrl URL dell'endpoint di delega. string
Validationkey Chiave di convalida con codifica base64 per garantire che le richieste provengono dal servizio di Gestione API di Azure. string

PortalConfigPropertiesSignin

Nome Descrizione Valore
require Reindirizzare utenti anonimi alla pagina di accesso. bool

PortalConfigPropertiesSignup

Nome Descrizione Valore
terminiOfService Condizioni per le impostazioni del servizio. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nome Descrizione Valore
requireConsent Chiedere all'utente il consenso per le condizioni di servizio. bool
text Termini di testo del servizio. string

Definizione della risorsa Terraform (provider AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2023-05-01-preview"
  name = "string"
  parent_id = "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à

service/portalconfigs

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/portalconfigs@2023-05-01-preview"
name Nome della risorsa stringa (obbligatoria)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
properties Proprietà del contratto di configurazione del portale per sviluppatori. PortalConfigProperties

PortalConfigProperties

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

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.comhttps://. string[]
mode Modalità del portale per sviluppatori Criteri di sicurezza del contenuto (CSP). "disabilitato"
"abilitato"
"reportOnly"
reportUri URL usati dal browser per segnalare violazioni del provider di servizi di rete. string[]

PortalConfigDelegationProperties

Nome Descrizione Valore
delegateRegistration Abilitare o disabilitare la delega per la registrazione utente. bool
delegateSubscription Abilitare o disabilitare la delega per le sottoscrizioni del prodotto. bool
delegaUrl URL dell'endpoint di delega. string
Validationkey Una chiave di convalida con codifica Base64 per garantire che le richieste provengano dal servizio azure Gestione API. string

PortalConfigPropertiesSignin

Nome Descrizione Valore
require Reindirizzare gli 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 per le condizioni per il servizio. bool
text Testo delle condizioni di servizio. string