Freigeben über

Workspace Group - Create Or Update

  • Referenz
Dienst:
API Management
API-Version:
2024-05-01

Erstellt oder aktualisiert eine Gruppe.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
groupId
 path True

string

minLength: 1
maxLength: 256

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Der Name des API-Verwaltungsdiensts.
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.displayName True

string

minLength: 1
maxLength: 300

Gruppenname.
properties.description

string

Gruppenbeschreibung.
properties.externalId

string

Bezeichner der externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory-aad://<tenant>.onmicrosoft.com/groups/<group object id>; andernfalls ist der Wert NULL.
properties.type

GroupType

Gruppentyp.

Antworten

Name Typ Beschreibung
200 OK

GroupContract

Gruppe ist bereits vorhanden.

Header

ETag: string
201 Created

GroupContract

Die Gruppe wurde erfolgreich erstellt.

Header

ETag: string
Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreateWorkspaceGroup
ApiManagementCreateWorkspaceGroupExternal

ApiManagementCreateWorkspaceGroup

Beispielanforderung

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup?api-version=2024-05-01

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

Beispiel für eine Antwort

Statuscode:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/workspaces/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}
Statuscode:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/workspaces/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}

ApiManagementCreateWorkspaceGroupExternal

Beispielanforderung

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup?api-version=2024-05-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"
  }
}

Beispiel für eine Antwort

Statuscode:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
  }
}
Statuscode:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
  }
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
GroupContract

Vertragsdetails.
GroupCreateParameters

Parameter, die für den Vorgang "Gruppe erstellen" bereitgestellt werden.
GroupType

Gruppentyp.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

GroupContract

Objekt

Vertragsdetails.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Der Name der Ressource
properties.builtIn

boolean

true, wenn die Gruppe eine der drei Systemgruppen ist (Administratoren, Entwickler oder Gäste); andernfalls "false".
properties.description

string

maxLength: 1000

Gruppenbeschreibung. Kann HTML-Formatierungstags enthalten.
properties.displayName

string

minLength: 1
maxLength: 300

Gruppenname.
properties.externalId

string

Bei externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory-aad://<tenant>.onmicrosoft.com/groups/<group object id>; andernfalls ist der Wert NULL.
properties.type

GroupType

Gruppentyp.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

GroupCreateParameters

Objekt

Parameter, die für den Vorgang "Gruppe erstellen" bereitgestellt werden.

Name Typ Beschreibung
properties.description

string

Gruppenbeschreibung.
properties.displayName

string

minLength: 1
maxLength: 300

Gruppenname.
properties.externalId

string

Bezeichner der externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory-aad://<tenant>.onmicrosoft.com/groups/<group object id>; andernfalls ist der Wert NULL.
properties.type

GroupType

Gruppentyp.

GroupType

Enumeration

Gruppentyp.

Wert Beschreibung
custom
external
system