Service Microsoft.ApiManagement/portalsettings 2024-06-01-preview

• dernière
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01

Définition de ressource Bicep

Le type de ressource service/portalsettings 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/portalsettings, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview' = {
  name: 'string'
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

objets microsoft.apimanagement/service/portalsettings

Définissez le nom propriété pour spécifier le type d’objet.

Pour de connexion, utilisez :

{
  name: 'signin'
  properties: {
    enabled: bool
  }
}

Pour d’inscription, utilisez :

{
  name: 'signup'
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

Pour de délégation, utilisez :

{
  name: 'delegation'
  properties: {
    subscriptions: {
      enabled: bool
    }
    url: 'string'
    userRegistration: {
      enabled: bool
    }
    validationKey: 'string'
  }
}

Valeurs de propriété

microsoft.apimanagement/service/portalsettings

Nom	Description	Valeur
nom	Défini sur « signin » pour le type Microsoft.ApiManagement/service/portalsettings. Définissez sur « inscription » pour le type Microsoft.ApiManagement/service/portalsettings. Défini sur « délégation » pour le type Microsoft.ApiManagement/service/portalsettings.	'délégation' 'signin' 'inscription' (obligatoire)

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'signin' (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 des paramètres de connexion.	PortalSigninSettingProperties

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'inscription' (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 des paramètres d’inscription.	PortalSignupSettingsProperties

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'délégation' (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 des paramètres de délégation.	PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Nom	Description	Valeur
Abonnements	Paramètres de délégation des abonnements.	SubscriptionsDelegationSettingsProperties
URL	URL de délégation.	corde
userRegistration	Paramètres de délégation d’inscription de l’utilisateur.	RegistrationDelegationSettingsProperties
validationKey	Une clé de validation encodée en base64 pour valider qu’une requête provient de Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

PortalSigninSettingProperties

Nom	Description	Valeur
Activé	Redirigez les utilisateurs anonymes vers la page Sign-In.	Bool

PortalSignupSettingsProperties

Nom	Description	Valeur
Activé	Autoriser les utilisateurs à s’inscrire sur un portail des développeurs.	Bool
termsOfService	Propriétés du contrat de service.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool

SubscriptionsDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour les abonnements.	Bool

TermsOfServiceProperties

Nom	Description	Valeur
consentRequired	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation.	Bool
Activé	Afficher les conditions d’utilisation pendant un processus d’inscription.	Bool
SMS	Texte des termes du service.	corde

Définition de ressource de modèle ARM

Le type de ressource service/portalsettings 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/portalsettings, ajoutez le code JSON suivant à votre modèle.

{
  "name": "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

objets microsoft.apimanagement/service/portalsettings

Définissez le nom propriété pour spécifier le type d’objet.

Pour de connexion, utilisez :

{
  "name": "signin",
  "properties": {
    "enabled": "bool"
  }
}

Pour d’inscription, utilisez :

{
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

Pour de délégation, utilisez :

{
  "name": "delegation",
  "properties": {
    "subscriptions": {
      "enabled": "bool"
    },
    "url": "string",
    "userRegistration": {
      "enabled": "bool"
    },
    "validationKey": "string"
  }
}

Valeurs de propriété

microsoft.apimanagement/service/portalsettings

Nom	Description	Valeur
nom	Défini sur « signin » pour le type Microsoft.ApiManagement/service/portalsettings. Définissez sur « inscription » pour le type Microsoft.ApiManagement/service/portalsettings. Défini sur « délégation » pour le type Microsoft.ApiManagement/service/portalsettings.	'délégation' 'signin' 'inscription' (obligatoire)

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-06-01-preview'
nom	Nom de la ressource	'signin' (obligatoire)
Propriétés	Propriétés du contrat des paramètres de connexion.	PortalSigninSettingProperties
type	Type de ressource	'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-06-01-preview'
nom	Nom de la ressource	'inscription' (obligatoire)
Propriétés	Propriétés du contrat des paramètres d’inscription.	PortalSignupSettingsProperties
type	Type de ressource	'Microsoft.ApiManagement/service/portalsettings'

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-06-01-preview'
nom	Nom de la ressource	'délégation' (obligatoire)
Propriétés	Propriétés du contrat des paramètres de délégation.	PortalDelegationSettingsProperties
type	Type de ressource	'Microsoft.ApiManagement/service/portalsettings'

PortalDelegationSettingsProperties

Nom	Description	Valeur
Abonnements	Paramètres de délégation des abonnements.	SubscriptionsDelegationSettingsProperties
URL	URL de délégation.	corde
userRegistration	Paramètres de délégation d’inscription de l’utilisateur.	RegistrationDelegationSettingsProperties
validationKey	Une clé de validation encodée en base64 pour valider qu’une requête provient de Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

PortalSigninSettingProperties

Nom	Description	Valeur
Activé	Redirigez les utilisateurs anonymes vers la page Sign-In.	Bool

PortalSignupSettingsProperties

Nom	Description	Valeur
Activé	Autoriser les utilisateurs à s’inscrire sur un portail des développeurs.	Bool
termsOfService	Propriétés du contrat de service.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool

SubscriptionsDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour les abonnements.	Bool

TermsOfServiceProperties

Nom	Description	Valeur
consentRequired	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation.	Bool
Activé	Afficher les conditions d’utilisation pendant un processus d’inscription.	Bool
SMS	Texte des termes du service.	corde

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/portalsettings 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/portalsettings, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  name = "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

objets microsoft.apimanagement/service/portalsettings

Définissez le nom propriété pour spécifier le type d’objet.

Pour de connexion, utilisez :

{
  name = "signin"
  properties = {
    enabled = bool
  }
}

Pour d’inscription, utilisez :

{
  name = "signup"
  properties = {
    enabled = bool
    termsOfService = {
      consentRequired = bool
      enabled = bool
      text = "string"
    }
  }
}

Pour de délégation, utilisez :

{
  name = "delegation"
  properties = {
    subscriptions = {
      enabled = bool
    }
    url = "string"
    userRegistration = {
      enabled = bool
    }
    validationKey = "string"
  }
}

Valeurs de propriété

microsoft.apimanagement/service/portalsettings

Nom	Description	Valeur
nom	Défini sur « signin » pour le type Microsoft.ApiManagement/service/portalsettings. Définissez sur « inscription » pour le type Microsoft.ApiManagement/service/portalsettings. Défini sur « délégation » pour le type Microsoft.ApiManagement/service/portalsettings.	'délégation' 'signin' 'inscription' (obligatoire)

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'signin' (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 des paramètres de connexion.	PortalSigninSettingProperties
type	Type de ressource	« Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview »

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'inscription' (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 des paramètres d’inscription.	PortalSignupSettingsProperties
type	Type de ressource	« Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview »

Microsoft.ApiManagement/service/portalsettings

Nom	Description	Valeur
nom	Nom de la ressource	'délégation' (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 des paramètres de délégation.	PortalDelegationSettingsProperties
type	Type de ressource	« Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview »

PortalDelegationSettingsProperties

Nom	Description	Valeur
Abonnements	Paramètres de délégation des abonnements.	SubscriptionsDelegationSettingsProperties
URL	URL de délégation.	corde
userRegistration	Paramètres de délégation d’inscription de l’utilisateur.	RegistrationDelegationSettingsProperties
validationKey	Une clé de validation encodée en base64 pour valider qu’une requête provient de Gestion des API Azure.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

PortalSigninSettingProperties

Nom	Description	Valeur
Activé	Redirigez les utilisateurs anonymes vers la page Sign-In.	Bool

PortalSignupSettingsProperties

Nom	Description	Valeur
Activé	Autoriser les utilisateurs à s’inscrire sur un portail des développeurs.	Bool
termsOfService	Propriétés du contrat de service.	TermsOfServiceProperties

RegistrationDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour l’inscription de l’utilisateur.	Bool

SubscriptionsDelegationSettingsProperties

Nom	Description	Valeur
Activé	Activez ou désactivez la délégation pour les abonnements.	Bool

TermsOfServiceProperties

Nom	Description	Valeur
consentRequired	Demandez à l’utilisateur de donner son consentement aux conditions d’utilisation.	Bool
Activé	Afficher les conditions d’utilisation pendant un processus d’inscription.	Bool
SMS	Texte des termes du service.	corde