Sign Up Settings - Create Or Update
Erstellen oder Aktualisieren von Sign-Up Einstellungen.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match |
string |
ETag der Entität. Nicht erforderlich beim Erstellen einer Entität, aber erforderlich beim Aktualisieren einer Entität. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
properties.enabled |
boolean |
Benutzern erlauben, sich bei einem Entwicklerportal zu registrieren. |
properties.termsOfService |
Eigenschaften von Vertragsbedingungen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Sign-Up Einstellungen wurden erfolgreich aktualisiert. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementPortalSettingsUpdateSignUp
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup?api-version=2022-08-01
{
"properties": {
"enabled": true,
"termsOfService": {
"enabled": true,
"text": "Terms of service text.",
"consentRequired": true
}
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup",
"type": "Microsoft.ApiManagement/service/portalsettings",
"name": "signup",
"properties": {
"enabled": true,
"termsOfService": {
"text": "Terms of service text.",
"enabled": true,
"consentRequired": true
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
Portal |
Sign-Up Einstellungen für ein Entwicklerportal. |
Terms |
Eigenschaften von Vertragsbedingungen. |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
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 der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
PortalSignupSettings
Sign-Up Einstellungen für ein Entwicklerportal.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.enabled |
boolean |
Benutzern erlauben, sich bei einem Entwicklerportal zu registrieren. |
properties.termsOfService |
Eigenschaften von Vertragsbedingungen. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
TermsOfServiceProperties
Eigenschaften von Vertragsbedingungen.
Name | Typ | Beschreibung |
---|---|---|
consentRequired |
boolean |
Bitten Sie den Benutzer um Zustimmung zu den Nutzungsbedingungen. |
enabled |
boolean |
Zeigen Sie die Nutzungsbedingungen während eines Registrierungsprozesses an. |
text |
string |
Ein Text für Nutzungsbedingungen. |