Service Microsoft.ApiManagement/portalconfigs 2022-08-01

Article
07/24/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez 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 de ressource

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-08-01' = {
  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é

service/portalconfigs

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	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 csp (Content Security Policy) du portail des développeurs.	PortalConfigCspProperties
délégation	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
inscription		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 du portail des développeurs (CSP).	'disabled' 'enabled' 'reportOnly'
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
delegateRegistration	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool
delegateSubscription	Activez ou désactivez la délégation pour les abonnements de produit.	Bool
delegationUrl	URL du point de terminaison de délégation.	corde
validationKey	Clé de validation encodée en base64 pour garantir que les requêtes proviennent du service Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

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.	Bool
SMS	Texte des termes du service.	corde

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez 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 de ressource

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

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

Valeurs de propriété

service/portalconfigs

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/portalconfigs'
apiVersion	Version de l’API de ressource	'2022-08-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire)
Propriétés	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 csp (Content Security Policy) du portail des développeurs.	PortalConfigCspProperties
délégation	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
inscription		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 du portail des développeurs (CSP).	'disabled' 'enabled' 'reportOnly'
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
delegateRegistration	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool
delegateSubscription	Activez ou désactivez la délégation pour les abonnements de produit.	Bool
delegationUrl	URL du point de terminaison de délégation.	corde
validationKey	Clé de validation encodée en base64 pour garantir que les requêtes proviennent du service Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

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.	Bool
SMS	Texte des termes du service.	corde

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 de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/portalconfigs, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
  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é

service/portalconfigs

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/portalconfigs@2022-08-01 »
nom	Nom de la ressource	chaîne (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : de service
Propriétés	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 csp (Content Security Policy) du portail des développeurs.	PortalConfigCspProperties
délégation	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
inscription		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 du portail des développeurs (CSP).	« désactivé » « activé » « reportOnly »
reportUri	URL utilisées par le navigateur pour signaler les violations csp.	string[]

PortalConfigDelegationProperties

Nom	Description	Valeur
delegateRegistration	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool
delegateSubscription	Activez ou désactivez la délégation pour les abonnements de produit.	Bool
delegationUrl	URL du point de terminaison de délégation.	corde
validationKey	Clé de validation encodée en base64 pour garantir que les requêtes proviennent du service Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

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.	Bool
SMS	Texte des termes du service.	corde

Partager via

Service Microsoft.ApiManagement/portalconfigs 2022-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service/portalconfigs

PortalConfigProperties

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service/portalconfigs

PortalConfigProperties

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service/portalconfigs

PortalConfigProperties

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigPropertiesSignin

PortalConfigPropertiesSignup

PortalConfigTermsOfServiceProperties

Commentaires

Ressources supplémentaires