Dela via

Microsoft.ApiManagement service/portalconfigs 2023-05-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen service/portalconfigs kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalconfigs-resurs lägger du till följande Bicep i mallen.

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'
      }
    }
  }
}

Egenskapsvärden

service/portalconfigs

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: tjänst
properties Egenskaperna för konfigurationskontraktet för utvecklarportalen. PortalConfigProperties

PortalConfigProperties

Name Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsEgenskaper
Csp Csp-inställningar (Content Security Policy) för utvecklarportalen. PortalConfigCspProperties
Delegationen Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationEgenskaper
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. boolesk
signin PortalConfigPropertiesSignin
Signup PortalConfigPropertiesSignup

PortalConfigCorsEgenskaper

Name Beskrivning Värde
allowedOrigins Tillåtna ursprung, t.ex. https://trusted.com. string[]

PortalConfigCspProperties

Name Beskrivning Värde
allowedSources Tillåtna källor, till exempel *.trusted.com, trusted.com, https://. string[]
mode Läget för utvecklarportalens innehållssäkerhetsprincip (CSP). "inaktiverad"
"aktiverad"
"reportOnly"
reportUri Url:erna som används av webbläsaren för att rapportera CSP-överträdelser. string[]

PortalConfigDelegationEgenskaper

Name Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. boolesk
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. boolesk
delegeringUrl En delegeringsslutpunkts-URL. sträng
validationKey En base64-kodad valideringsnyckel för att säkerställa att begäranden kommer från Azure API Management-tjänsten. sträng

PortalConfigPropertiesSignin

Name Beskrivning Värde
Kräver Omdirigera anonyma användare till inloggningssidan. boolesk

PortalConfigPropertiesSignup

Name Beskrivning Värde
termsOfService Villkor för tjänstinställningar. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beskrivning Värde
requireConsent Be användaren om medgivande till användarvillkoren. boolesk
text En villkorstext för tjänsten. sträng

Resursdefinition för ARM-mall

Resurstypen service/portalconfigs kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalconfigs-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

service/portalconfigs

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/portalconfigs"
apiVersion Resurs-API-versionen "2023-05-01-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Egenskaperna för konfigurationskontraktet för utvecklarportalen. PortalConfigProperties

PortalConfigProperties

Name Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsEgenskaper
Csp Csp-inställningar (Content Security Policy) för utvecklarportalen. PortalConfigCspProperties
Delegationen Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationEgenskaper
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. boolesk
signin PortalConfigPropertiesSignin
Signup PortalConfigPropertiesSignup

PortalConfigCorsEgenskaper

Name Beskrivning Värde
allowedOrigins Tillåtna ursprung, t.ex. https://trusted.com. string[]

PortalConfigCspProperties

Name Beskrivning Värde
allowedSources Tillåtna källor, till exempel *.trusted.com, trusted.com, https://. string[]
mode Läget för utvecklarportalens innehållssäkerhetsprincip (CSP). "inaktiverad"
"aktiverad"
"reportOnly"
reportUri Url:erna som används av webbläsaren för att rapportera CSP-överträdelser. string[]

PortalConfigDelegationEgenskaper

Name Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. boolesk
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. boolesk
delegeringUrl En delegeringsslutpunkts-URL. sträng
validationKey En base64-kodad valideringsnyckel för att säkerställa att begäranden kommer från Azure API Management-tjänsten. sträng

PortalConfigPropertiesSignin

Name Beskrivning Värde
Kräver Omdirigera anonyma användare till inloggningssidan. boolesk

PortalConfigPropertiesSignup

Name Beskrivning Värde
termsOfService Inställningar för användningsvillkor. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beskrivning Värde
requireConsent Be användaren om medgivande till användningsvillkoren. boolesk
text En term för servicetext. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen service/portalconfigs kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/portalconfigs-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

service/portalconfigs

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/portalconfigs@2023-05-01-preview"
name Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
properties Egenskaperna för utvecklarportalens konfigurationskontrakt. PortalConfigProperties

PortalConfigProperties

Name Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsProperties
Csp Inställningar för innehållssäkerhetsprincip (CSP) i utvecklarportalen. PortalConfigCspProperties
Delegationen Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationProperties
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. boolesk
signin PortalConfigPropertiesSignin
Signup PortalConfigPropertiesSignup

PortalConfigCorsProperties

Name Beskrivning Värde
allowedOrigins Tillåtna ursprung, t.ex. https://trusted.com. string[]

PortalConfigCspProperties

Name Beskrivning Värde
allowedSources Tillåtna källor, t.ex. *.trusted.com, trusted.com, https://. string[]
mode Läget för utvecklarportalens innehållssäkerhetsprincip (CSP). "inaktiverad"
"aktiverad"
"reportOnly"
reportUri Url:erna som används av webbläsaren för att rapportera CSP-överträdelser. string[]

PortalConfigDelegationProperties

Name Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. boolesk
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. boolesk
delegeringUrl En URL för delegeringsslutpunkt. sträng
validationKey En base64-kodad valideringsnyckel för att säkerställa att begäranden kommer från Azure API Management-tjänsten. sträng

PortalConfigPropertiesSignin

Name Beskrivning Värde
Kräver Omdirigera anonyma användare till inloggningssidan. boolesk

PortalConfigPropertiesSignup

Name Beskrivning Värde
termsOfService Villkor för tjänstinställningar. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beskrivning Värde
requireConsent Be användaren om medgivande till användarvillkoren. boolesk
text En villkorstext för tjänsten. sträng