Partager via


Tenant Settings - List By Service

Paramètres publics.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings?$filter={$filter}&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 du client.

$filter
query

string

Non utilisé

Réponses

Nom Type Description
200 OK

TenantSettingsCollection

Répertorie une collection d’entités TenantSettings.

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

ApiManagementListTenantSettings

Exemple de requête

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

Exemple de réponse

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public",
      "type": "Microsoft.ApiManagement/service/settings",
      "name": "public",
      "properties": {
        "settings": {
          "CustomPortalSettings.UserRegistrationTerms": null,
          "CustomPortalSettings.UserRegistrationTermsEnabled": "False",
          "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False",
          "CustomPortalSettings.DelegationEnabled": "False",
          "CustomPortalSettings.DelegationUrl": "",
          "CustomPortalSettings.DelegatedSubscriptionEnabled": "False"
        }
      }
    }
  ],
  "nextLink": ""
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

TenantSettingsCollection

Représentation de liste AccessInformation paginée.

TenantSettingsContract

Paramètres du locataire.

ErrorFieldContract

Contrat de 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 des propriétés.

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.

TenantSettingsCollection

Représentation de liste AccessInformation paginée.

Nom Type Description
nextLink

string

Lien de la page suivante, le cas échéant.

value

TenantSettingsContract[]

Valeurs de page.

TenantSettingsContract

Paramètres du locataire.

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.settings

object

Paramètres du locataire

type

string

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