Portal Config - Create Or Update

Tjänst:

API Management

API-version:

2024-05-01

Skapa eller uppdatera konfigurationen av utvecklarportalen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
portalConfigId	path	True	string minLength: 1 maxLength: 80	Portalkonfigurationsidentifierare.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

Begärandetext

Name	Typ	Description
properties.cors	PortalConfigCorsProperties	Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen.
properties.csp	PortalConfigCspProperties	CsP-inställningarna (Content Security Policy) för utvecklarportalen.
properties.delegation	PortalConfigDelegationProperties	Delegeringsinställningarna för utvecklarportalen.
properties.enableBasicAuth	boolean	Aktivera eller inaktivera grundläggande autentiseringsmetod.
properties.signin	Signin
properties.signup	Signup

Svar

Name	Typ	Description
200 OK	PortalConfigContract	Åtgärden har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementCreatePortalConfig

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
PortalConfigContract	Konfigurationskontraktet för utvecklarportalen.
PortalConfigCorsProperties	Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen.
PortalConfigCspProperties	CsP-inställningarna (Content Security Policy) för utvecklarportalen.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Egenskaper för tjänstevillkorskontrakt.
PortalSettingsCspMode	Läget för utvecklarportalens innehållssäkerhetsprincip (CSP).
Signin
Signup

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

PortalConfigContract

Objekt

Konfigurationskontraktet för utvecklarportalen.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Namnet på resursen
properties.cors	PortalConfigCorsProperties		Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen.
properties.csp	PortalConfigCspProperties		CsP-inställningarna (Content Security Policy) för utvecklarportalen.
properties.delegation	PortalConfigDelegationProperties		Delegeringsinställningarna för utvecklarportalen.
properties.enableBasicAuth	boolean	True	Aktivera eller inaktivera grundläggande autentiseringsmetod.
properties.signin	Signin
properties.signup	Signup
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Objekt

Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen.

Name	Typ	Description
allowedOrigins	string[]	Tillåtet ursprung, t.ex. https://trusted.com.

PortalConfigCspProperties

Objekt

CsP-inställningarna (Content Security Policy) för utvecklarportalen.

Name	Typ	Standardvärde	Description
allowedSources	string[]		Tillåtna källor, t.ex. *.trusted.com, trusted.com, https://.
mode	PortalSettingsCspMode	disabled	Läget för utvecklarportalens innehållssäkerhetsprincip (CSP).
reportUri	string[]		URL:er som används av webbläsaren för att rapportera CSP-överträdelser.

PortalConfigDelegationProperties

Objekt

Name	Typ	Standardvärde	Description
delegateRegistration	boolean	False	Aktivera eller inaktivera delegering för användarregistrering.
delegateSubscription	boolean	False	Aktivera eller inaktivera delegering för produktprenumerationer.
delegationUrl	string		En delegeringsslutpunkts-URL.
validationKey	string		En base64-kodad valideringsnyckel för att säkerställa att begäranden kommer från Azure API Management-tjänsten.

PortalConfigTermsOfServiceProperties

Objekt

Egenskaper för tjänstevillkorskontrakt.

Name	Typ	Standardvärde	Description
requireConsent	boolean	False	Be användaren om medgivande till användarvillkoren.
text	string		En text om villkor för tjänsten.

PortalSettingsCspMode

Uppräkning

Läget för utvecklarportalens innehållssäkerhetsprincip (CSP).

Värde	Description
enabled	Webbläsaren blockerar begäranden som inte matchar tillåtna ursprung.
disabled	Webbläsaren tillämpar inte ursprungsbegränsningarna.
reportOnly	Webbläsaren rapporterar begäranden som inte matchar tillåtna ursprung utan att blockera dem.

Signin

Objekt

Name	Typ	Standardvärde	Description
require	boolean	False	Omdirigera anonyma användare till inloggningssidan.

Signup

Objekt

Name	Typ	Description
termsOfService	PortalConfigTermsOfServiceProperties	Villkor för tjänstinställningar.