Delen via


Tenant Settings - Get

Tenantinstellingen ophalen.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep.

serviceName
path True

string

De naam van de API Management service.

Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

settingsType
path True

settingsTypeName

De id van de instellingen.

subscriptionId
path True

string

Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name Type Description
200 OK

TenantSettingsContract

Tenantinstellingen.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetTenantSettings

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorFieldContract

Fout Veldcontract.

ErrorResponse

Foutreactie.

settingsTypeName

De id van de instellingen.

TenantSettingsContract

Tenantinstellingen.

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

settingsTypeName

De id van de instellingen.

Name Type Description
public

string

TenantSettingsContract

Tenantinstellingen.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.settings

object

Tenantinstellingen

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'