Dela via

Microsoft.ApiManagement service/portalconfigs 2024-06-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@2024-06-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'
      }
    }
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/portalconfigs

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper Egenskaperna för konfigurationskontraktet för utvecklarportalen. PortalConfigProperties

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Namn Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. Bool
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. Bool
delegationUrl 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalConfigProperties

Namn Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsProperties
Csp CsP-inställningarna (Content Security Policy) för utvecklarportalen. PortalConfigCspProperties
delegation Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationProperties
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. Bool
signin PortalConfigPropertiesSignin
registrera dig PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Namn Beskrivning Värde
behöva Omdirigera anonyma användare till inloggningssidan. Bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Namn Beskrivning Värde
requireConsent Be användaren om medgivande till användarvillkoren. Bool
SMS En text om villkor 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": "2024-06-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

Microsoft.ApiManagement/service/portalconfigs

Namn Beskrivning Värde
apiVersion API-versionen "2024-06-01-preview"
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Egenskaper Egenskaperna för konfigurationskontraktet för utvecklarportalen. PortalConfigProperties
typ Resurstypen "Microsoft.ApiManagement/service/portalconfigs"

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Namn Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. Bool
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. Bool
delegationUrl 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalConfigProperties

Namn Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsProperties
Csp CsP-inställningarna (Content Security Policy) för utvecklarportalen. PortalConfigCspProperties
delegation Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationProperties
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. Bool
signin PortalConfigPropertiesSignin
registrera dig PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Namn Beskrivning Värde
behöva Omdirigera anonyma användare till inloggningssidan. Bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Namn Beskrivning Värde
requireConsent Be användaren om medgivande till användarvillkoren. Bool
SMS En text om villkor för tjänsten. 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@2024-06-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"
        }
      }
    }
  })
}

Egenskapsvärden

Microsoft.ApiManagement/service/portalconfigs

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (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
Egenskaper Egenskaperna för konfigurationskontraktet för utvecklarportalen. PortalConfigProperties
typ Resurstypen "Microsoft.ApiManagement/service/portalconfigs@2024-06-01-preview"

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Namn Beskrivning Värde
delegateRegistration Aktivera eller inaktivera delegering för användarregistrering. Bool
delegateSubscription Aktivera eller inaktivera delegering för produktprenumerationer. Bool
delegationUrl 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

PortalConfigProperties

Namn Beskrivning Värde
cors Cors-inställningar (Cross-Origin Resource Sharing) i utvecklarportalen. PortalConfigCorsProperties
Csp CsP-inställningarna (Content Security Policy) för utvecklarportalen. PortalConfigCspProperties
delegation Delegeringsinställningarna för utvecklarportalen. PortalConfigDelegationProperties
enableBasicAuth Aktivera eller inaktivera grundläggande autentiseringsmetod. Bool
signin PortalConfigPropertiesSignin
registrera dig PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Namn Beskrivning Värde
behöva Omdirigera anonyma användare till inloggningssidan. Bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Namn Beskrivning Värde
requireConsent Be användaren om medgivande till användarvillkoren. Bool
SMS En text om villkor för tjänsten. sträng