Sign In Settings - Get

Anmeldeeinstellungen für das Portal abrufen

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

URI-Parameter

Name In Required Type Description
resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

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

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name Type Description
200 OK

Sign-In Einstellungen.

Headers

  • ETag: string
Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementPortalSettingsGetSignIn

Sample Request

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

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin",
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "name": "signin",
  "properties": {
    "enabled": true
  }
}

Definitionen

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

PortalSigninSettings

Sign-In Einstellungen für das Entwicklerportal.

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Humanlesbare Darstellung des Fehlers auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.

error.message
  • string

Lesbare Darstellung des Fehlers.

PortalSigninSettings

Sign-In Einstellungen für das Entwicklerportal.

Name Type Description
id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Der Name der Ressource

properties.enabled
  • boolean

Leiten Sie anonyme Benutzer an die Sign-In Seite um.

type
  • string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"