Group - Create Or Update

Tworzy lub aktualizuje grupę.

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

Parametry identyfikatora URI

Name In Required Type Description
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.

serviceName
path True
  • string

Nazwa usługi API Management.

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

subscriptionId
path True
  • string

Poświadczenia subskrypcji, które jednoznacznie identyfikują Microsoft Azure subskrypcji. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API do użycia z żądaniem klienta.

Nagłówek żądania

Name Required Type Description
If-Match
  • string

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

Treść żądania

Name Required Type Description
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 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; w przeciwnym razie wartość ma wartość null.

properties.type

Typ grupy.

Odpowiedzi

Name Type Description
200 OK

Grupa już istnieje.

Headers

  • ETag: string
201 Created

Grupa została pomyślnie utworzona.

Headers

  • ETag: string
Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementCreateGroup
ApiManagementCreateGroupExternal

ApiManagementCreateGroup

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2020-12-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": "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2020-12-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"
  }
}

Sample Response

{
  "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

ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

GroupContract

Szczegóły kontraktu.

GroupCreateParameters

Parametry dostarczone do operacji Tworzenia grupy.

GroupType

Typ grupy.

ErrorFieldContract

Błąd Kontrakt pola.

Name Type Description
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.

Name Type Description
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 jest wysyłana w żądaniu w przypadku błędu walidacji.

error.message
  • string

Czytelna dla człowieka reprezentacja błędu.

GroupContract

Szczegóły kontraktu.

Name Type Description
id
  • string

Identyfikator zasobu.

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

properties.type

Typ grupy.

type
  • string

Typ zasobu dla zasobu API Management.

GroupCreateParameters

Parametry dostarczone do operacji Tworzenia grupy.

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

properties.type

Typ grupy.

GroupType

Typ grupy.

Name Type Description
custom
  • string
external
  • string
system
  • string