Condividi tramite


Tenant Settings - Get

Ottenere le impostazioni del tenant.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse.

serviceName
path True

string

Nome del servizio Gestione API.

Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

settingsType
path True

settingsTypeName

Identificatore delle impostazioni.

subscriptionId
path True

string

Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True

string

Versione dell'API da usare con la richiesta client.

Risposte

Nome Tipo Descrizione
200 OK

TenantSettingsContract

Impostazioni tenant.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementGetTenantSettings

Esempio di richiesta

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

Risposta di esempio

{
  "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"
    }
  }
}

Definizioni

Nome Descrizione
ErrorFieldContract

Contratto campo errore.

ErrorResponse

Risposta errore.

settingsTypeName

Identificatore delle impostazioni.

TenantSettingsContract

Impostazioni tenant.

ErrorFieldContract

Contratto campo errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.

message

string

Rappresentazione leggibile dell'errore a livello di proprietà.

target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

settingsTypeName

Identificatore delle impostazioni.

Nome Tipo Descrizione
public

string

TenantSettingsContract

Impostazioni tenant.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.settings

object

Impostazioni tenant

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"