Group - Update
Frissítések az azonosító által megadott csoport adatait.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
group
|
path | True |
string |
Csoportazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Regex pattern: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
If-Match | True |
string |
Az entitás ETagje. Az ETagnek meg kell egyeznie a GET-kérés fejlécválaszában szereplő aktuális entitásállapotmal, vagy a feltétel nélküli frissítéshez * kell lennie. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
properties.description |
string |
Csoport leírása. |
properties.displayName |
string |
Csoport neve. |
properties.externalId |
string |
A külső csoportok azonosítója, ez a tulajdonság a külső identitásszolgáltatótól származó csoport azonosítóját tartalmazza, például az Azure Active Directory |
properties.type |
Csoport típusa. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A csoport adatai sikeresen frissültek. Headers ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ApiManagementUpdateGroup
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2022-08-01
{
"properties": {
"displayName": "temp group"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "tempgroup",
"properties": {
"displayName": "tempgroup",
"description": "awesome group of people",
"builtIn": false,
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
}
}
Definíciók
Name | Description |
---|---|
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Group |
Szerződés részletei. |
Group |
Csoport típusa. |
Group |
A Frissítési csoport művelethez megadott paraméterek. |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
GroupContract
Szerződés részletei.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.builtIn |
boolean |
igaz, ha a csoport a három rendszercsoport egyike (rendszergazdák, fejlesztők vagy vendégek); egyéb esetben hamis. |
properties.description |
string |
Csoport leírása. HTML-formázási címkéket tartalmazhat. |
properties.displayName |
string |
Csoport neve. |
properties.externalId |
string |
Külső csoportok esetén ez a tulajdonság a külső identitásszolgáltatótól származó csoport azonosítóját tartalmazza, például az Azure Active Directory |
properties.type |
Csoport típusa. |
|
type |
string |
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
GroupType
Csoport típusa.
Name | Típus | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
GroupUpdateParameters
A Frissítési csoport művelethez megadott paraméterek.
Name | Típus | Description |
---|---|---|
properties.description |
string |
Csoport leírása. |
properties.displayName |
string |
Csoport neve. |
properties.externalId |
string |
A külső csoportok azonosítója, ez a tulajdonság a külső identitásszolgáltatótól származó csoport azonosítóját tartalmazza, például az Azure Active Directory |
properties.type |
Csoport típusa. |