Portal Config - Update

Dienst:

API Management

API-Version:

2024-05-01

Aktualisieren Sie die Konfiguration des Entwicklerportals.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
portalConfigId	path	True	string minLength: 1 maxLength: 80	Portalkonfigurations-ID.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.cors	PortalConfigCorsProperties	Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS).
properties.csp	PortalConfigCspProperties	Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.
properties.delegation	PortalConfigDelegationProperties	Die Delegierungseinstellungen des Entwicklerportals.
properties.enableBasicAuth	boolean	Aktivieren oder Deaktivieren der Standardauthentifizierungsmethode.
properties.signin	Signin
properties.signup	Signup

Antworten

Name	Typ	Beschreibung
200 OK	PortalConfigContract	Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdatePortalConfig

Beispielanforderung

HTTP

PATCH 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"
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:

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"
      ]
    }
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PortalConfigContract	Der Konfigurationsvertrag für das Entwicklerportal.
PortalConfigCorsProperties	Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS).
PortalConfigCspProperties	Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Servicevertragseigenschaften.
PortalSettingsCspMode	Der Modus der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.
Signin
Signup

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PortalConfigContract

Objekt

Der Konfigurationsvertrag für das Entwicklerportal.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.cors	PortalConfigCorsProperties		Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS).
properties.csp	PortalConfigCspProperties		Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.
properties.delegation	PortalConfigDelegationProperties		Die Delegierungseinstellungen des Entwicklerportals.
properties.enableBasicAuth	boolean	True	Aktivieren oder Deaktivieren der Standardauthentifizierungsmethode.
properties.signin	Signin
properties.signup	Signup
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Objekt

Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS).

Name	Typ	Beschreibung
allowedOrigins	string[]	Zulässige Ursprünge, z. B. https://trusted.com.

PortalConfigCspProperties

Objekt

Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.

Name	Typ	Standardwert	Beschreibung
allowedSources	string[]		Zulässige Quellen, z. B. *.trusted.com, trusted.com, https://.
mode	PortalSettingsCspMode	disabled	Der Modus der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.
reportUri	string[]		Die URLs, die vom Browser zum Melden von CSP-Verstößen verwendet werden.

PortalConfigDelegationProperties

Objekt

Name	Typ	Standardwert	Beschreibung
delegateRegistration	boolean	False	Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung.
delegateSubscription	boolean	False	Aktivieren oder Deaktivieren der Delegierung für Produktabonnements.
delegationUrl	string		Eine Delegierungsendpunkt-URL.
validationKey	string		Ein base64-codierter Überprüfungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API-Verwaltungsdienst stammen.

PortalConfigTermsOfServiceProperties

Objekt

Servicevertragseigenschaften.

Name	Typ	Standardwert	Beschreibung
requireConsent	boolean	False	Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen.
text	string		Ein Nutzungsbedingungentext.

PortalSettingsCspMode

Enumeration

Der Modus der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals.

Wert	Beschreibung
disabled	Der Browser gilt nicht für die Ursprungsbeschränkungen.
enabled	Der Browser blockiert Anforderungen, die nicht mit zulässigen Ursprüngen übereinstimmen.
reportOnly	Der Browser meldet Anforderungen, die nicht mit zulässigen Ursprüngen übereinstimmen, ohne sie zu blockieren.

Signin

Objekt

Name	Typ	Standardwert	Beschreibung
require	boolean	False	Leiten Sie anonyme Benutzer zur Anmeldeseite um.

Signup

Objekt

Name	Typ	Beschreibung
termsOfService	PortalConfigTermsOfServiceProperties	Nutzungsbedingungen.