Udostępnij za pośrednictwem


Group - Create Or Update

Tworzy lub Aktualizacje grupę.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
groupId
path True

string

Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

Wzorzec wyrażenia regularnego: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

ETag jednostki. Nie jest wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa Wymagane Typ Opis
properties.displayName True

string

Nazwa grupy.

properties.description

string

Opis grupy.

properties.externalId

string

Identyfikator grup zewnętrznych, ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. dla usługi Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; w przeciwnym razie wartość ma wartość null.

properties.type

GroupType

Typ grupy.

Odpowiedzi

Nazwa Typ Opis
200 OK

GroupContract

Grupa już istnieje.

Nagłówki

ETag: string

201 Created

GroupContract

Grupa została pomyślnie utworzona.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

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

ApiManagementCreateGroup
ApiManagementCreateGroupExternal

ApiManagementCreateGroup

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2022-08-01

{
  "properties": {
    "displayName": "temp group"
  }
}

Przykładowa odpowiedź

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}

ApiManagementCreateGroupExternal

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2022-08-01

{
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

Przykładowa odpowiedź

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

GroupContract

Szczegóły umowy.

GroupCreateParameters

Parametry dostarczone do operacji Tworzenie grupy.

GroupType

Typ grupy.

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

ErrorFieldContract[]

Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.

error.message

string

Czytelna dla człowieka reprezentacja błędu.

GroupContract

Szczegóły umowy.

Nazwa Typ 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.builtIn

boolean

prawda, jeśli grupa jest jedną z trzech grup systemowych (Administratorzy, Deweloperzy lub Goście); w przeciwnym razie wartość false.

properties.description

string

Opis grupy. Może zawierać tagi formatowania HTML.

properties.displayName

string

Nazwa grupy.

properties.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 aad://<tenant>.onmicrosoft.com/groups/<group object id>; w przeciwnym razie wartość ma wartość null.

properties.type

GroupType

Typ grupy.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

GroupCreateParameters

Parametry dostarczone do operacji Tworzenie grupy.

Nazwa Typ Opis
properties.description

string

Opis grupy.

properties.displayName

string

Nazwa grupy.

properties.externalId

string

Identyfikator grup zewnętrznych, ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. dla usługi Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; w przeciwnym razie wartość ma wartość null.

properties.type

GroupType

Typ grupy.

GroupType

Typ grupy.

Nazwa Typ Opis
custom

string

external

string

system

string