Group - Update

Service:

API Management

API-versie:

2024-05-01

Hiermee worden de details van de groep bijgewerkt die is opgegeven met de id.

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

URI-parameters

Name	In	Vereist	Type	Description
groupId	path	True	string minLength: 1 maxLength: 256	Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.description	string	Groepsbeschrijving.
properties.displayName	string minLength: 1 maxLength: 300	Groepsnaam.
properties.externalId	string	Id van de externe groepen, deze eigenschap bevat de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; anders is de waarde null.
properties.type	GroupType	Groepstype.

Antwoorden

Name	Type	Description
200 OK	GroupContract	De groepsdetails zijn bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateGroup

Voorbeeldaanvraag

HTTP

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


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

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GroupContract	Contractgegevens.
GroupType	Groepstype.
GroupUpdateParameters	Parameters die zijn opgegeven bij de bewerking Updategroep.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GroupContract

Object

Contractgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.builtIn	boolean	waar als de groep een van de drie systeemgroepen is (beheerders, ontwikkelaars of gasten); anders onwaar.
properties.description	string maxLength: 1000	Groepsbeschrijving. Kan HTML-opmaaktags bevatten.
properties.displayName	string minLength: 1 maxLength: 300	Groepsnaam.
properties.externalId	string	Voor externe groepen bevat deze eigenschap de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; anders is de waarde null.
properties.type	GroupType	Groepstype.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

GroupType

Inventarisatie

Groepstype.

Waarde	Description
custom
external
system

GroupUpdateParameters

Object

Parameters die zijn opgegeven bij de bewerking Updategroep.

Name	Type	Description
properties.description	string	Groepsbeschrijving.
properties.displayName	string minLength: 1 maxLength: 300	Groepsnaam.
properties.externalId	string	Id van de externe groepen, deze eigenschap bevat de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; anders is de waarde null.
properties.type	GroupType	Groepstype.