Group - Create Or Update

Csoportot hoz létre vagy frissít.

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

URI-paraméterek

Name In Required Type Description
groupId
path True
  • string

Csoportazonosító. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban.

resourceGroupName
path True
  • string

Az erőforráscsoport neve.

serviceName
path True
  • string

A API Management szolgáltatás neve.

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

subscriptionId
path True
  • string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják Microsoft Azure előfizetést. Az előfizetés-azonosító minden szolgáltatáshívás URI-jának részét képezi.

api-version
query True
  • string

Az ügyfélkéréshez használandó API verziója.

Kérelem fejléce

Name Required Type Description
If-Match
  • string

Az entitás ETagje. Az entitások létrehozásakor nem kötelező, de az entitások frissítésekor kötelező.

Kérelem törzse

Name Required Type Description
properties.displayName True
  • string

Csoport neve.

properties.description
  • string

Csoport leírása.

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 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; ellenkező esetben az érték null.

properties.type

Csoport típusa.

Válaszok

Name Type Description
200 OK

A csoport már létezik.

Headers

  • ETag: string
201 Created

A csoport létrehozása sikerült.

Headers

  • ETag: string
Other Status Codes

Hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

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

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

Definíciók

ErrorFieldContract

Hibamező szerződése.

ErrorResponse

Hibaválasz.

GroupContract

Szerződés részletei.

GroupCreateParameters

A Csoport létrehozása művelethez megadott paraméterek.

GroupType

Csoport típusa.

ErrorFieldContract

Hibamező szerződése.

Name Type Description
code
  • string

Tulajdonságszintű hibakód.

message
  • string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target
  • string

Tulajdonságnév.

ErrorResponse

Hibaválasz.

Name Type 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üldhető el a kérésben.

error.message
  • string

A hiba emberi olvasásra alkalmas ábrázolása.

GroupContract

Szerződés részletei.

Name Type Description
id
  • string

Erőforrás-azonosító.

name
  • string

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 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; ellenkező esetben az érték null.

properties.type

Csoport típusa.

type
  • string

Erőforrástípus API Management erőforráshoz.

GroupCreateParameters

A Csoport létrehozása művelethez megadott paraméterek.

Name Type 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 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; ellenkező esetben az érték null.

properties.type

Csoport típusa.

GroupType

Csoport típusa.

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