Tenant Settings - Get
Obter definições de inquilino.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/public?api-version=2021-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Padrão Regex: |
settings
|
path | True |
O identificador das definições. |
|
subscription
|
path | True |
string |
Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
api-version
|
query | True |
string |
Versão da API a utilizar com o pedido de cliente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Definições do Inquilino. Cabeçalhos ETag: string |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ApiManagementGetTenantSettings
Pedido de amostra
Resposta da amostra
{
"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"
}
}
}
Definições
Name | Description |
---|---|
Error |
Contrato de campo de erro. |
Error |
Resposta a Erros. |
settings |
O identificador das definições. |
Tenant |
Definições do Inquilino. |
ErrorFieldContract
Contrato de campo de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro ao nível da propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta a Erros.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados a pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
settingsTypeName
O identificador das definições.
Name | Tipo | Description |
---|---|---|
public |
string |
TenantSettingsContract
Definições do Inquilino.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.settings |
object |
Definições do inquilino |
type |
string |
O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |