Microsoft.ApiManagement-service/portalconfigs 2022-04-01-preview

• meest recente
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview-
• 2023-03-01-preview-
• 2022-09-01-preview-
• 2022-08-01
• 2022-04-01-preview-
• 2021-12-01-preview-

Bicep-resourcedefinitie

Het resourcetype service/portalconfigs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/portalconfigs wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-04-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'
      }
    }
  }
}

Eigenschapswaarden

Microsoft.ApiManagement/service/portalconfigs

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
ouder	In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.	Symbolische naam voor resource van het type: service
Eigenschappen	De eigenschappen van het configuratiecontract voor de ontwikkelaarsportal.	PortalConfigProperties-

PortalConfigCorsProperties

Naam	Beschrijving	Waarde
allowedOrigins	Toegestane oorsprongen, bijvoorbeeld https://trusted.com.	tekenreeks[]

PortalConfigCspProperties

Naam	Beschrijving	Waarde
allowedSources	Toegestane bronnen, bijvoorbeeld *.trusted.com, trusted.com, https://.	tekenreeks[]
wijze	De modus van het Content Security Policy (CSP) van de ontwikkelaarsportal.	'uitgeschakeld' 'ingeschakeld' 'reportOnly'
reportUri	De URL's die door de browser worden gebruikt om CSP-schendingen te melden.	tekenreeks[]

PortalConfigDelegationProperties

Naam	Beschrijving	Waarde
delegateRegistration	Delegatie voor gebruikersregistratie in- of uitschakelen.	Bool
delegateSubscription	Delegering voor productabonnementen in- of uitschakelen.	Bool
delegationUrl	Een eindpunt-URL voor delegering.	snaar
validationKey	Een met base64 gecodeerde validatiesleutel om ervoor te zorgen dat aanvragen afkomstig zijn van de Azure API Management-service.	snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter.

PortalConfigProperties

Naam	Beschrijving	Waarde
cors	De CORS-instellingen (Cross-Origin Resource Sharing) van de ontwikkelaarsportal.	PortalConfigCorsProperties-
Csp	De CSP-instellingen (Content Security Policy) van de ontwikkelaarsportal.	PortalConfigCspProperties-
delegatie	De instellingen voor delegatie van de ontwikkelaarsportal.	PortalConfigDelegationProperties-
enableBasicAuth	Basisverificatiemethode in- of uitschakelen.	Bool
aanmelden		PortalConfigPropertiesSignin-
registreren		PortalConfigPropertiesSignup-

PortalConfigPropertiesSignin

Naam	Beschrijving	Waarde
vereisen	Anonieme gebruikers omleiden naar de aanmeldingspagina.	Bool

PortalConfigPropertiesSignup

Naam	Beschrijving	Waarde
termsOfService	Servicevoorwaarden.	PortalConfigTermsOfServiceProperties-

PortalConfigTermsOfServiceProperties

Naam	Beschrijving	Waarde
requireConsent	Vraag de gebruiker om toestemming voor de servicevoorwaarden.	Bool
Sms	Een servicevoorwaardentekst.	snaar

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/portalconfigs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource voor Microsoft.ApiManagement/service/portalconfigs wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2022-04-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"
      }
    }
  }
}

Eigenschapswaarden

Microsoft.ApiManagement/service/portalconfigs

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2022-04-01-preview'
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
Eigenschappen	De eigenschappen van het configuratiecontract voor de ontwikkelaarsportal.	PortalConfigProperties-
type	Het resourcetype	'Microsoft.ApiManagement/service/portalconfigs'

PortalConfigCorsProperties

Naam	Beschrijving	Waarde
allowedOrigins	Toegestane oorsprongen, bijvoorbeeld https://trusted.com.	tekenreeks[]

PortalConfigCspProperties

Naam	Beschrijving	Waarde
allowedSources	Toegestane bronnen, bijvoorbeeld *.trusted.com, trusted.com, https://.	tekenreeks[]
wijze	De modus van het Content Security Policy (CSP) van de ontwikkelaarsportal.	'uitgeschakeld' 'ingeschakeld' 'reportOnly'
reportUri	De URL's die door de browser worden gebruikt om CSP-schendingen te melden.	tekenreeks[]

PortalConfigDelegationProperties

Naam	Beschrijving	Waarde
delegateRegistration	Delegatie voor gebruikersregistratie in- of uitschakelen.	Bool
delegateSubscription	Delegering voor productabonnementen in- of uitschakelen.	Bool
delegationUrl	Een eindpunt-URL voor delegering.	snaar
validationKey	Een met base64 gecodeerde validatiesleutel om ervoor te zorgen dat aanvragen afkomstig zijn van de Azure API Management-service.	snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter.

PortalConfigProperties

Naam	Beschrijving	Waarde
cors	De CORS-instellingen (Cross-Origin Resource Sharing) van de ontwikkelaarsportal.	PortalConfigCorsProperties-
Csp	De CSP-instellingen (Content Security Policy) van de ontwikkelaarsportal.	PortalConfigCspProperties-
delegatie	De instellingen voor delegatie van de ontwikkelaarsportal.	PortalConfigDelegationProperties-
enableBasicAuth	Basisverificatiemethode in- of uitschakelen.	Bool
aanmelden		PortalConfigPropertiesSignin-
registreren		PortalConfigPropertiesSignup-

PortalConfigPropertiesSignin

Naam	Beschrijving	Waarde
vereisen	Anonieme gebruikers omleiden naar de aanmeldingspagina.	Bool

PortalConfigPropertiesSignup

Naam	Beschrijving	Waarde
termsOfService	Servicevoorwaarden.	PortalConfigTermsOfServiceProperties-

PortalConfigTermsOfServiceProperties

Naam	Beschrijving	Waarde
requireConsent	Vraag de gebruiker om toestemming voor de servicevoorwaarden.	Bool
Sms	Een servicevoorwaardentekst.	snaar

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/portalconfigs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource voor Microsoft.ApiManagement/service/portalconfigs wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-04-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"
        }
      }
    }
  })
}

Eigenschapswaarden

Microsoft.ApiManagement/service/portalconfigs

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: service-
Eigenschappen	De eigenschappen van het configuratiecontract voor de ontwikkelaarsportal.	PortalConfigProperties-
type	Het resourcetype	"Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"

PortalConfigCorsProperties

Naam	Beschrijving	Waarde
allowedOrigins	Toegestane oorsprongen, bijvoorbeeld https://trusted.com.	tekenreeks[]

PortalConfigCspProperties

Naam	Beschrijving	Waarde
allowedSources	Toegestane bronnen, bijvoorbeeld *.trusted.com, trusted.com, https://.	tekenreeks[]
wijze	De modus van het Content Security Policy (CSP) van de ontwikkelaarsportal.	'uitgeschakeld' 'ingeschakeld' 'reportOnly'
reportUri	De URL's die door de browser worden gebruikt om CSP-schendingen te melden.	tekenreeks[]

PortalConfigDelegationProperties

Naam	Beschrijving	Waarde
delegateRegistration	Delegatie voor gebruikersregistratie in- of uitschakelen.	Bool
delegateSubscription	Delegering voor productabonnementen in- of uitschakelen.	Bool
delegationUrl	Een eindpunt-URL voor delegering.	snaar
validationKey	Een met base64 gecodeerde validatiesleutel om ervoor te zorgen dat aanvragen afkomstig zijn van de Azure API Management-service.	snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter.

PortalConfigProperties

Naam	Beschrijving	Waarde
cors	De CORS-instellingen (Cross-Origin Resource Sharing) van de ontwikkelaarsportal.	PortalConfigCorsProperties-
Csp	De CSP-instellingen (Content Security Policy) van de ontwikkelaarsportal.	PortalConfigCspProperties-
delegatie	De instellingen voor delegatie van de ontwikkelaarsportal.	PortalConfigDelegationProperties-
enableBasicAuth	Basisverificatiemethode in- of uitschakelen.	Bool
aanmelden		PortalConfigPropertiesSignin-
registreren		PortalConfigPropertiesSignup-

PortalConfigPropertiesSignin

Naam	Beschrijving	Waarde
vereisen	Anonieme gebruikers omleiden naar de aanmeldingspagina.	Bool

PortalConfigPropertiesSignup

Naam	Beschrijving	Waarde
termsOfService	Servicevoorwaarden.	PortalConfigTermsOfServiceProperties-

PortalConfigTermsOfServiceProperties

Naam	Beschrijving	Waarde
requireConsent	Vraag de gebruiker om toestemming voor de servicevoorwaarden.	Bool
Sms	Een servicevoorwaardentekst.	snaar