User - Update
Aktualizacje szczegóły użytkownika określonego przez jego identyfikator.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
service
|
path | True |
string |
Nazwa usługi API Management. Wzorzec wyrażenia regularnego: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
user
|
path | True |
string |
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
If-Match | True |
string |
ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * w przypadku aktualizacji bezwarunkowej. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
properties.email |
string |
Adres e-mail. Nie może być pusty i musi być unikatowy w ramach wystąpienia usługi. |
properties.firstName |
string |
Imię. |
properties.identities |
Kolekcja tożsamości użytkowników. |
|
properties.lastName |
string |
Nazwisko. |
properties.note |
string |
Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora. |
properties.password |
string |
Hasło użytkownika. |
properties.state |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Użytkownik został pomyślnie zaktualizowany. Nagłówki ETag: string |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
ApiManagementUpdateUser
Przykładowe żądanie
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2022-08-01
{
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com"
}
}
Przykładowa odpowiedź
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512a88c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2017-06-02T17:58:50.357Z",
"identities": [
{
"provider": "Microsoft",
"id": "*************"
}
]
}
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Group |
Właściwości kontraktu grupy. |
Group |
Typ grupy. |
User |
Szczegóły użytkownika. |
User |
Szczegóły tożsamości użytkownika. |
User |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |
User |
Parametry aktualizacji użytkownika. |
ErrorFieldContract
Błąd Kontrakt pola.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu poziomu właściwości. |
message |
string |
Czytelna dla człowieka reprezentacja błędu na poziomie właściwości. |
target |
string |
Nazwa właściwości. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error.code |
string |
Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi. |
error.details |
Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji. |
|
error.message |
string |
Czytelna dla człowieka reprezentacja błędu. |
GroupContractProperties
Właściwości kontraktu grupy.
Nazwa | Typ | Opis |
---|---|---|
builtIn |
boolean |
prawda, jeśli grupa jest jedną z trzech grup systemowych (Administratorzy, Deweloperzy lub Goście); w przeciwnym razie wartość false. |
description |
string |
Opis grupy. Może zawierać tagi formatowania HTML. |
displayName |
string |
Nazwa grupy. |
externalId |
string |
W przypadku grup zewnętrznych ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. dla usługi Azure Active Directory |
type |
Typ grupy. |
GroupType
Typ grupy.
Nazwa | Typ | Opis |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserContract
Szczegóły użytkownika.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
Nazwa zasobu |
|
properties.email |
string |
Adres e-mail. |
|
properties.firstName |
string |
Imię. |
|
properties.groups |
Kolekcja użytkowników grup jest częścią. |
||
properties.identities |
Kolekcja tożsamości użytkowników. |
||
properties.lastName |
string |
Nazwisko. |
|
properties.note |
string |
Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora. |
|
properties.registrationDate |
string |
Data rejestracji użytkownika. Data jest zgodna z następującym formatem: |
|
properties.state | active |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |
|
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
UserIdentityContract
Szczegóły tożsamości użytkownika.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Wartość identyfikatora w obrębie dostawcy. |
provider |
string |
Nazwa dostawcy tożsamości. |
UserState
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny.
Nazwa | Typ | Opis |
---|---|---|
active |
string |
Stan użytkownika jest aktywny. |
blocked |
string |
Użytkownik jest zablokowany. Zablokowani użytkownicy nie mogą uwierzytelniać się w portalu deweloperów ani wywoływać interfejsu API. |
deleted |
string |
Konto użytkownika jest zamknięte. Wszystkie tożsamości i powiązane jednostki są usuwane. |
pending |
string |
Konto użytkownika oczekuje. Wymaga potwierdzenia tożsamości, zanim będzie można go uaktywnić. |
UserUpdateParameters
Parametry aktualizacji użytkownika.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
properties.email |
string |
Adres e-mail. Nie może być pusty i musi być unikatowy w ramach wystąpienia usługi. |
|
properties.firstName |
string |
Imię. |
|
properties.identities |
Kolekcja tożsamości użytkowników. |
||
properties.lastName |
string |
Nazwisko. |
|
properties.note |
string |
Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora. |
|
properties.password |
string |
Hasło użytkownika. |
|
properties.state | active |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |