Freigeben über

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

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/portalconfigs kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/portalconfigs-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep-Ressource hinzu.

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

Eigenschaftswerte

service/portalconfigs

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Dienst
properties Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties

PortalConfigProperties

Name BESCHREIBUNG Wert
cors Die CORS-Einstellungen (Cross-Origin Resource Sharing) des Entwicklerportals. PortalConfigCorsProperties
Csp Die Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder deaktivieren Sie die Standardauthentifizierungsmethode. bool
signin PortalConfigPropertiesSignin
anmelden PortalConfigPropertiesSignup

PortalConfigCorsProperties

Name BESCHREIBUNG Wert
allowedOrigins Zulässige Ursprünge, z. B. https://trusted.com. string[]

PortalConfigCspProperties

Name BESCHREIBUNG Wert
allowedSources Zulässige Quellen, z. B. *.trusted.com, trusted.com, https://. string[]
Modus Der Modus der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. "deaktiviert"
"aktiviert"
"reportOnly"
reportUri Die URLs, die vom Browser verwendet werden, um CSP-Verstöße zu melden. string[]

PortalConfigDelegationProperties

Name BESCHREIBUNG Wert
delegateRegistration Aktivieren oder deaktivieren Sie die Delegierung für die Benutzerregistrierung. bool
delegateSubscription Aktivieren oder deaktivieren Sie die Delegierung für Produktabonnements. bool
delegationUrl Eine Delegierungsendpunkt-URL. Zeichenfolge
Validationkey Ein Base64-codierter Validierungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API Management-Dienst stammen. Zeichenfolge

PortalConfigPropertiesSignin

Name BESCHREIBUNG Wert
require Leiten Sie anonyme Benutzer zur Anmeldeseite um. bool

PortalConfigPropertiesSignup

Name BESCHREIBUNG Wert
termsOfService Nutzungsbedingungeneinstellungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name BESCHREIBUNG Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. bool
text Ein Nutzungsbedingungentext. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/portalconfigs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/portalconfigs-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

service/portalconfigs

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/portalconfigs"
apiVersion Die Ressourcen-API-Version '2022-04-01-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
properties Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties

PortalConfigProperties

Name BESCHREIBUNG Wert
cors Die CORS-Einstellungen (Cross-Origin Resource Sharing, Cross-Origin Resource Sharing) des Entwicklerportals. PortalConfigCorsProperties
Csp Die Einstellungen der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder deaktivieren Sie die Standardauthentifizierungsmethode. bool
signin PortalConfigPropertiesSignin
anmelden PortalConfigPropertiesSignup

PortalConfigCorsProperties

Name BESCHREIBUNG Wert
allowedOrigins Zulässige Ursprünge, z. B. https://trusted.com. string[]

PortalConfigCspProperties

Name BESCHREIBUNG Wert
allowedSources Zulässige Quellen, z. B. *.trusted.com, trusted.com, https://. string[]
Modus Der Modus des Entwicklerportals Inhaltssicherheitsrichtlinie (CSP). "deaktiviert"
"aktiviert"
"reportOnly"
reportUri Die URLs, die vom Browser verwendet werden, um CSP-Verstöße zu melden. string[]

PortalConfigDelegationProperties

Name BESCHREIBUNG Wert
delegateRegistration Aktivieren oder deaktivieren Sie die Delegierung für die Benutzerregistrierung. bool
delegateSubscription Aktivieren oder deaktivieren Sie die Delegierung für Produktabonnements. bool
delegationUrl Eine Delegierungsendpunkt-URL. Zeichenfolge
Validationkey Ein Base64-codierter Validierungsschlüssel, um sicherzustellen, dass Anforderungen von Azure API Management Dienst stammen. Zeichenfolge

PortalConfigPropertiesSignin

Name BESCHREIBUNG Wert
require Leiten Sie anonyme Benutzer zur Anmeldeseite um. bool

PortalConfigPropertiesSignup

Name BESCHREIBUNG Wert
termsOfService Nutzungsbedingungeneinstellungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name BESCHREIBUNG Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. bool
text Ein Nutzungsbedingungentext. Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp service/portalconfigs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/portalconfigs-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

service/portalconfigs

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties

PortalConfigProperties

Name BESCHREIBUNG Wert
cors Die CORS-Einstellungen (Cross-Origin Resource Sharing, Cross-Origin Resource Sharing) des Entwicklerportals. PortalConfigCorsProperties
Csp Die Einstellungen der Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder deaktivieren Sie die Standardauthentifizierungsmethode. bool
signin PortalConfigPropertiesSignin
anmelden PortalConfigPropertiesSignup

PortalConfigCorsProperties

Name BESCHREIBUNG Wert
allowedOrigins Zulässige Ursprünge, z. B. https://trusted.com. string[]

PortalConfigCspProperties

Name BESCHREIBUNG Wert
allowedSources Zulässige Quellen, z. B. *.trusted.com, trusted.com, https://. string[]
Modus Der Modus des Entwicklerportals Inhaltssicherheitsrichtlinie (CSP). "disabled"
"enabled"
"reportOnly"
reportUri Die URLs, die vom Browser verwendet werden, um CSP-Verstöße zu melden. string[]

PortalConfigDelegationProperties

Name BESCHREIBUNG Wert
delegateRegistration Aktivieren oder deaktivieren Sie die Delegierung für die Benutzerregistrierung. bool
delegateSubscription Aktivieren oder deaktivieren Sie die Delegierung für Produktabonnements. bool
delegationUrl Eine Delegierungsendpunkt-URL. Zeichenfolge
Validationkey Ein Base64-codierter Validierungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API Management-Dienst stammen. Zeichenfolge

PortalConfigPropertiesSignin

Name BESCHREIBUNG Wert
require Leiten Sie anonyme Benutzer zur Anmeldeseite um. bool

PortalConfigPropertiesSignup

Name BESCHREIBUNG Wert
termsOfService Einstellungen für Nutzungsbedingungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name BESCHREIBUNG Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. bool
text Ein Text für Nutzungsbedingungen. Zeichenfolge