Partager via


Delegation Settings - Create Or Update

Créer ou mettre à jour des paramètres de délégation.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation?api-version=2021-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API à utiliser avec la demande cliente.

En-tête de la demande

Nom Obligatoire Type Description
If-Match

string

ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom Type Description
properties.subscriptions

SubscriptionsDelegationSettingsProperties

Paramètres de délégation d’abonnements.

properties.url

string

Url de délégation.

properties.userRegistration

RegistrationDelegationSettingsProperties

Paramètres de délégation d’inscription utilisateur.

properties.validationKey

string

Clé de validation encodée en base64 à valider, qu’une requête provient d’Azure Gestion des API.

Réponses

Nom Type Description
200 OK

PortalDelegationSettings

Les paramètres de délégation ont été correctement mis à jour.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementPortalSettingsUpdateDelegation

Exemple de requête

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation?api-version=2021-08-01


{
  "properties": {
    "url": "http://contoso.com/delegation",
    "validationKey": "<validationKey>",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

Exemple de réponse

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation",
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "name": "delegation",
  "properties": {
    "url": "http://contoso.com/delegation",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

Définitions

Nom Description
ErrorFieldContract

Contrat champ d’erreur.

ErrorResponse

Réponse d’erreur.

PortalDelegationSettings

Paramètres de délégation pour un portail des développeurs.

RegistrationDelegationSettingsProperties

Propriétés des paramètres de délégation d’inscription utilisateur.

SubscriptionsDelegationSettingsProperties

Propriétés des paramètres de délégation d’abonnements.

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

Représentation lisible par l’homme de l’erreur au niveau de la propriété.

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation contrôlable de visu de l’erreur.

PortalDelegationSettings

Paramètres de délégation pour un portail des développeurs.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.subscriptions

SubscriptionsDelegationSettingsProperties

Paramètres de délégation d’abonnements.

properties.url

string

Url de délégation.

properties.userRegistration

RegistrationDelegationSettingsProperties

Paramètres de délégation d’inscription utilisateur.

properties.validationKey

string

Clé de validation encodée en base64 à valider, qu’une requête provient d’Azure Gestion des API.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

RegistrationDelegationSettingsProperties

Propriétés des paramètres de délégation d’inscription utilisateur.

Nom Type Description
enabled

boolean

Activez ou désactivez la délégation pour l’inscription des utilisateurs.

SubscriptionsDelegationSettingsProperties

Propriétés des paramètres de délégation d’abonnements.

Nom Type Description
enabled

boolean

Activez ou désactivez la délégation pour les abonnements.