Portal Config - Create Or Update

Servizio:: API Management

Versione API:: 2024-05-01

Creare o aggiornare la configurazione del portale per sviluppatori.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}?api-version=2024-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
portalConfigId	path	True	string minLength: 1 maxLength: 80	Identificatore di configurazione del portale.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match	True	string	ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.cors	PortalConfigCorsProperties	Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori.
properties.csp	PortalConfigCspProperties	Impostazioni CSP (Content Security Policy) del portale per sviluppatori.
properties.delegation	PortalConfigDelegationProperties	Impostazioni di delega del portale per sviluppatori.
properties.enableBasicAuth	boolean	Abilitare o disabilitare il metodo di autenticazione di base.
properties.signin	Signin
properties.signup	Signup

Risposte

Nome	Tipo	Descrizione
200 OK	PortalConfigContract	Operazione completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreatePortalConfig

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default?api-version=2024-05-01


{
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PortalConfigContract	Contratto di configurazione del portale per sviluppatori.
PortalConfigCorsProperties	Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori.
PortalConfigCspProperties	Impostazioni CSP (Content Security Policy) del portale per sviluppatori.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Condizioni per le proprietà del contratto di servizio.
PortalSettingsCspMode	Modalità dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori.
Signin
Signup

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PortalConfigContract

Object

Contratto di configurazione del portale per sviluppatori.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nome della risorsa
properties.cors	PortalConfigCorsProperties		Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori.
properties.csp	PortalConfigCspProperties		Impostazioni CSP (Content Security Policy) del portale per sviluppatori.
properties.delegation	PortalConfigDelegationProperties		Impostazioni di delega del portale per sviluppatori.
properties.enableBasicAuth	boolean	True	Abilitare o disabilitare il metodo di autenticazione di base.
properties.signin	Signin
properties.signup	Signup
type	string		Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

Impostazioni CORS (Cross-Origin Resource Sharing) del portale per sviluppatori.

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

PortalConfigCspProperties

Object

Impostazioni CSP (Content Security Policy) del portale per sviluppatori.

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

PortalConfigDelegationProperties

Object

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

PortalConfigTermsOfServiceProperties

Object

Condizioni per le proprietà del contratto di servizio.

Nome	Tipo	Valore predefinito	Descrizione
requireConsent	boolean	False	Chiedere all'utente il consenso alle condizioni per il servizio.
text	string		Testo relativo alle condizioni per il servizio.

PortalSettingsCspMode

Enumerazione

Modalità dei criteri di sicurezza del contenuto (CSP) del portale per sviluppatori.

Valore	Descrizione
enabled	Il browser blocca le richieste che non corrispondono alle origini consentite.
disabled	Il browser non applicherà le restrizioni di origine.
reportOnly	Il browser segnala le richieste che non corrispondono alle origini consentite senza bloccarle.

Object

Nome	Tipo	Valore predefinito	Descrizione
require	boolean	False	Reindirizzare utenti anonimi alla pagina di accesso.

Object

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

Condividi tramite

Portal Config - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreatePortalConfig

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup