Freigeben über

Microsoft.ApiManagement service/portalconfigs 2023-05-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 unter Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

Microsoft.ApiManagement/service/portalconfigs

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Elternteil 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 des Typs: Dienst-
Eigenschaften Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties

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 zum Melden von CSP-Verstößen verwendet werden. string[]

PortalConfigDelegationProperties

Name Beschreibung Wert
delegateRegistration Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. Bool
delegateSubscription Aktivieren oder Deaktivieren der Delegierung für Produktabonnements. Bool
delegationUrl Eine Delegierungsendpunkt-URL. Schnur
validationKey Ein base64-codierter Überprüfungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API-Verwaltungsdienst stammen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

PortalConfigProperties

Name Beschreibung Wert
Cors Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS). PortalConfigCorsProperties-
csp Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
Delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder Deaktivieren der Standardauthentifizierungsmethode. Bool
signin PortalConfigPropertiesSignin
Registrierung PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Beschreibung Wert
erfordern Leiten Sie anonyme Benutzer zur Anmeldeseite um. Bool

PortalConfigPropertiesSignup

Name Beschreibung Wert
termsOfService Nutzungsbedingungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beschreibung Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. Bool
Text Ein Nutzungsbedingungentext. Schnur

ARM-Vorlagenressourcendefinition

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

Eigenschaftswerte

Microsoft.ApiManagement/service/portalconfigs

Name Beschreibung Wert
apiVersion Die API-Version "2023-05-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Eigenschaften Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties
Art Der Ressourcentyp 'Microsoft.ApiManagement/service/portalconfigs'

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 zum Melden von CSP-Verstößen verwendet werden. string[]

PortalConfigDelegationProperties

Name Beschreibung Wert
delegateRegistration Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. Bool
delegateSubscription Aktivieren oder Deaktivieren der Delegierung für Produktabonnements. Bool
delegationUrl Eine Delegierungsendpunkt-URL. Schnur
validationKey Ein base64-codierter Überprüfungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API-Verwaltungsdienst stammen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

PortalConfigProperties

Name Beschreibung Wert
Cors Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS). PortalConfigCorsProperties-
csp Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
Delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder Deaktivieren der Standardauthentifizierungsmethode. Bool
signin PortalConfigPropertiesSignin
Registrierung PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Beschreibung Wert
erfordern Leiten Sie anonyme Benutzer zur Anmeldeseite um. Bool

PortalConfigPropertiesSignup

Name Beschreibung Wert
termsOfService Nutzungsbedingungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beschreibung Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. Bool
Text Ein Nutzungsbedingungentext. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

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

  • 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 Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.ApiManagement/service/portalconfigs

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Die Konfigurationsvertragseigenschaften des Entwicklerportals. PortalConfigProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/portalconfigs@2023-05-01-preview"

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 zum Melden von CSP-Verstößen verwendet werden. string[]

PortalConfigDelegationProperties

Name Beschreibung Wert
delegateRegistration Aktivieren oder Deaktivieren der Delegierung für die Benutzerregistrierung. Bool
delegateSubscription Aktivieren oder Deaktivieren der Delegierung für Produktabonnements. Bool
delegationUrl Eine Delegierungsendpunkt-URL. Schnur
validationKey Ein base64-codierter Überprüfungsschlüssel, um sicherzustellen, dass Anforderungen vom Azure API-Verwaltungsdienst stammen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

PortalConfigProperties

Name Beschreibung Wert
Cors Einstellungen für das Entwicklerportal cross-Origin Resource Sharing (CORS). PortalConfigCorsProperties-
csp Einstellungen für die Inhaltssicherheitsrichtlinie (Content Security Policy, CSP) des Entwicklerportals. PortalConfigCspProperties
Delegation Die Delegierungseinstellungen des Entwicklerportals. PortalConfigDelegationProperties
enableBasicAuth Aktivieren oder Deaktivieren der Standardauthentifizierungsmethode. Bool
signin PortalConfigPropertiesSignin
Registrierung PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Beschreibung Wert
erfordern Leiten Sie anonyme Benutzer zur Anmeldeseite um. Bool

PortalConfigPropertiesSignup

Name Beschreibung Wert
termsOfService Nutzungsbedingungen. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Beschreibung Wert
requireConsent Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. Bool
Text Ein Nutzungsbedingungentext. Schnur