Service Microsoft.ApiManagement/portalconfigs 2022-09-01-preview

• La plus récente
• 2023-05-01-preview
• Préversion du 01/03/2023
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview

Définition de ressource Bicep

Le type de ressource service/portalconfigs peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/portalconfigs, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

service/portalconfigs

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	chaîne (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : service
properties	Propriétés du contrat de configuration du portail des développeurs.	PortalConfigProperties

PortalConfigProperties

Nom	Description	Valeur
cors	Paramètres cors (Cross-Origin Resource Sharing) du portail des développeurs.	PortalConfigCorsProperties
Csp	Paramètres de stratégie de sécurité du contenu (CSP) du portail des développeurs.	PortalConfigCspProperties
delegation	Paramètres de délégation du portail des développeurs.	PortalConfigDelegationProperties
enableBasicAuth	Activez ou désactivez la méthode d’authentification de base.	bool
signin		PortalConfigPropertiesSignin
signup		PortalConfigPropertiesSignup

PortalConfigCorsProperties

Nom	Description	Valeur
allowedOrigins	Origines autorisées, par exemple https://trusted.com.	string[]

PortalConfigCspProperties

Nom	Description	Valeur
allowedSources	Sources autorisées, par exemple *.trusted.com, trusted.com, https://.	string[]
mode	Mode du portail des développeurs Stratégie de sécurité du contenu (CSP).	'disabled' 'enabled' 'reportOnly'
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
déléguéRegistration	Activez ou désactivez la délégation pour l’inscription des utilisateurs.	bool
déléguéSubscription	Activez ou désactivez la délégation pour les abonnements de produits.	bool
delegationUrl	URL de point de terminaison de délégation.	string
validationKey	Clé de validation encodée en base64 pour garantir que les demandes proviennent du service Azure Gestion des API.	string

PortalConfigPropertiesSignin

Nom	Description	Valeur
exiger	Redirigez les utilisateurs anonymes vers la page de connexion.	bool

PortalConfigPropertiesSignup

Nom	Description	Valeur
termsOfService	Paramètres des conditions d’utilisation du service.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nom	Description	Valeur
requireConsent	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation du service.	bool
text	Texte des conditions d’utilisation.	string

Définition de ressources de modèle ARM

Le type de ressource service/portalconfigs peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/portalconfigs, ajoutez le json suivant à votre modèle.

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

Valeurs de propriétés

service/portalconfigs

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/portalconfigs'
apiVersion	Version de l’API de ressource	'2022-09-01-preview'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	string (obligatoire)
properties	Propriétés du contrat de configuration du portail des développeurs.	PortalConfigProperties

PortalConfigProperties

Nom	Description	Valeur
cors	Paramètres CORS (Cross-Origin Resource Sharing) du portail des développeurs.	PortalConfigCorsProperties
Csp	Paramètres de stratégie de sécurité du contenu (CSP) du portail des développeurs.	PortalConfigCspProperties
delegation	Paramètres de délégation du portail des développeurs.	PortalConfigDelegationProperties
enableBasicAuth	Activez ou désactivez la méthode d’authentification de base.	bool
signin		PortalConfigPropertiesSignin
signup		PortalConfigPropertiesSignup

PortalConfigCorsProperties

Nom	Description	Valeur
allowedOrigins	Origines autorisées, par exemple https://trusted.com.	string[]

PortalConfigCspProperties

Nom	Description	Valeur
allowedSources	Sources autorisées, par exemple *.trusted.com, trusted.com, https://.	string[]
mode	Mode de la stratégie de sécurité du contenu (CSP) du portail des développeurs.	'disabled' 'enabled' 'reportOnly'
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
delegateRegistration	Activer ou désactiver la délégation pour l’inscription des utilisateurs.	bool
delegateSubscription	Activer ou désactiver la délégation pour les abonnements aux produits.	bool
delegationUrl	URL de point de terminaison de délégation.	string
validationKey	Une clé de validation encodée en base64 pour garantir que les requêtes proviennent du service Azure Gestion des API.	string

PortalConfigPropertiesSignin

Nom	Description	Valeur
exiger	Redirigez les utilisateurs anonymes vers la page de connexion.	bool

PortalConfigPropertiesSignup

Nom	Description	Valeur
termsOfService	Paramètres des conditions d’utilisation du service.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nom	Description	Valeur
requireConsent	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation du service.	bool
text	Texte des conditions d’utilisation.	string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/portalconfigs peut être déployé avec des opérations qui ciblent :

• Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/portalconfigs, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

service/portalconfigs

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/portalconfigs@2022-09-01-preview »
name	Nom de la ressource	string (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : service
properties	Propriétés du contrat de configuration du portail des développeurs.	PortalConfigProperties

PortalConfigProperties

Nom	Description	Valeur
cors	Paramètres CORS (Cross-Origin Resource Sharing) du portail des développeurs.	PortalConfigCorsProperties
Csp	Paramètres de stratégie de sécurité du contenu (CSP) du portail des développeurs.	PortalConfigCspProperties
delegation	Paramètres de délégation du portail des développeurs.	PortalConfigDelegationProperties
enableBasicAuth	Activez ou désactivez la méthode d’authentification de base.	bool
signin		PortalConfigPropertiesSignin
signup		PortalConfigPropertiesSignup

PortalConfigCorsProperties

Nom	Description	Valeur
allowedOrigins	Origines autorisées, par exemple https://trusted.com.	string[]

PortalConfigCspProperties

Nom	Description	Valeur
allowedSources	Sources autorisées, par exemple *.trusted.com, trusted.com, https://.	string[]
mode	Mode de la stratégie de sécurité du contenu (CSP) du portail des développeurs.	"disabled" (désactivé) "enabled" (activé) « reportOnly »
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
delegateRegistration	Activer ou désactiver la délégation pour l’inscription des utilisateurs.	bool
delegateSubscription	Activer ou désactiver la délégation pour les abonnements aux produits.	bool
delegationUrl	URL de point de terminaison de délégation.	string
validationKey	Clé de validation encodée en base64 pour garantir que les demandes proviennent du service Azure Gestion des API.	string

PortalConfigPropertiesSignin

Nom	Description	Valeur
exiger	Redirigez les utilisateurs anonymes vers la page de connexion.	bool

PortalConfigPropertiesSignup

Nom	Description	Valeur
termsOfService	Paramètres des conditions d’utilisation.	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Nom	Description	Valeur
requireConsent	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation.	bool
text	Texte des conditions d’utilisation.	string