Sdílet prostřednictvím

Služba Microsoft.ApiManagement / portalconfigs 2024-05-01

  • Článek

Definice prostředku Bicep

Typ prostředku service/portalconfigs je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalconfigs, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2024-05-01' = {
  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'
      }
    }
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/portalconfigs

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu konfiguračního kontraktu portálu pro vývojáře PortalConfigProperties

PortalConfigCorsProperties

Jméno Popis Hodnota
allowedOrigins Povolené původy, např. https://trusted.com. string[]

PortalConfigCspProperties

Jméno Popis Hodnota
allowedSources Povolené zdroje, např. *.trusted.com, trusted.com, https://. string[]
režim Režim zásad zabezpečení obsahu portálu pro vývojáře (CSP). Zakázáno
Povoleno
'reportOnly'
reportUri Adresy URL používané prohlížečem k hlášení porušení CSP. string[]

PortálConfigDelegationProperties

Jméno Popis Hodnota
delegateRegistration Povolte nebo zakažte delegování pro registraci uživatelů. Bool
delegateSubscription Povolte nebo zakažte delegování pro předplatná produktů. Bool
delegationUrl Adresa URL koncového bodu delegování řetězec
validationKey Ověřovací klíč zakódovaný v base64, který zajišťuje, že požadavky pocházejí ze služby Azure API Management. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

PortalConfigProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS) na portálu pro vývojáře PortalConfigCorsProperties
Csp Nastavení zásad zabezpečení obsahu (CSP) na portálu pro vývojáře PortalConfigCspProperties
delegace Nastavení delegování portálu pro vývojáře PortalConfigDelegationProperties
enableBasicAuth Povolte nebo zakažte metodu základního ověřování. Bool
signin PortalConfigPropertiesSignin
registrace PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Jméno Popis Hodnota
vyžadovat Přesměrujte anonymní uživatele na přihlašovací stránku. Bool

PortalConfigPropertiesSignup

Jméno Popis Hodnota
termsOfService Podmínky nastavení služby. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Jméno Popis Hodnota
requireConsent Požádejte uživatele o souhlas s podmínkami služby. Bool
Text Text podmínek služby. řetězec

Definice prostředku šablony ARM

Typ prostředku service/portalconfigs je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalconfigs, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/portalconfigs

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-01'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
vlastnosti Vlastnosti kontraktu konfiguračního kontraktu portálu pro vývojáře PortalConfigProperties
typ Typ prostředku Microsoft.ApiManagement/service/portalconfigs

PortalConfigCorsProperties

Jméno Popis Hodnota
allowedOrigins Povolené původy, např. https://trusted.com. string[]

PortalConfigCspProperties

Jméno Popis Hodnota
allowedSources Povolené zdroje, např. *.trusted.com, trusted.com, https://. string[]
režim Režim zásad zabezpečení obsahu portálu pro vývojáře (CSP). Zakázáno
Povoleno
'reportOnly'
reportUri Adresy URL používané prohlížečem k hlášení porušení CSP. string[]

PortálConfigDelegationProperties

Jméno Popis Hodnota
delegateRegistration Povolte nebo zakažte delegování pro registraci uživatelů. Bool
delegateSubscription Povolte nebo zakažte delegování pro předplatná produktů. Bool
delegationUrl Adresa URL koncového bodu delegování řetězec
validationKey Ověřovací klíč zakódovaný v base64, který zajišťuje, že požadavky pocházejí ze služby Azure API Management. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

PortalConfigProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS) na portálu pro vývojáře PortalConfigCorsProperties
Csp Nastavení zásad zabezpečení obsahu (CSP) na portálu pro vývojáře PortalConfigCspProperties
delegace Nastavení delegování portálu pro vývojáře PortalConfigDelegationProperties
enableBasicAuth Povolte nebo zakažte metodu základního ověřování. Bool
signin PortalConfigPropertiesSignin
registrace PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Jméno Popis Hodnota
vyžadovat Přesměrujte anonymní uživatele na přihlašovací stránku. Bool

PortalConfigPropertiesSignup

Jméno Popis Hodnota
termsOfService Podmínky nastavení služby. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Jméno Popis Hodnota
requireConsent Požádejte uživatele o souhlas s podmínkami služby. Bool
Text Text podmínek služby. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/portalconfigs je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/portalconfigs, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/portalconfigs

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu konfiguračního kontraktu portálu pro vývojáře PortalConfigProperties
typ Typ prostředku Microsoft.ApiManagement/service/portalconfigs@2024-05-01

PortalConfigCorsProperties

Jméno Popis Hodnota
allowedOrigins Povolené původy, např. https://trusted.com. string[]

PortalConfigCspProperties

Jméno Popis Hodnota
allowedSources Povolené zdroje, např. *.trusted.com, trusted.com, https://. string[]
režim Režim zásad zabezpečení obsahu portálu pro vývojáře (CSP). Zakázáno
Povoleno
'reportOnly'
reportUri Adresy URL používané prohlížečem k hlášení porušení CSP. string[]

PortálConfigDelegationProperties

Jméno Popis Hodnota
delegateRegistration Povolte nebo zakažte delegování pro registraci uživatelů. Bool
delegateSubscription Povolte nebo zakažte delegování pro předplatná produktů. Bool
delegationUrl Adresa URL koncového bodu delegování řetězec
validationKey Ověřovací klíč zakódovaný v base64, který zajišťuje, že požadavky pocházejí ze služby Azure API Management. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

PortalConfigProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS) na portálu pro vývojáře PortalConfigCorsProperties
Csp Nastavení zásad zabezpečení obsahu (CSP) na portálu pro vývojáře PortalConfigCspProperties
delegace Nastavení delegování portálu pro vývojáře PortalConfigDelegationProperties
enableBasicAuth Povolte nebo zakažte metodu základního ověřování. Bool
signin PortalConfigPropertiesSignin
registrace PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Jméno Popis Hodnota
vyžadovat Přesměrujte anonymní uživatele na přihlašovací stránku. Bool

PortalConfigPropertiesSignup

Jméno Popis Hodnota
termsOfService Podmínky nastavení služby. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Jméno Popis Hodnota
requireConsent Požádejte uživatele o souhlas s podmínkami služby. Bool
Text Text podmínek služby. řetězec