Product Group - Create Or Update

Ajoute l’association entre le groupe de développeurs spécifié et le produit spécifié.

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

Paramètres URI

Name In Required Type Description
groupId
path True
  • string

Identificateur de groupe. Doit être unique dans l’instance actuelle du service gestion des API.

productId
path True
  • string

Identificateur de produit. Doit être unique dans l’instance actuelle du service gestion des API.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service gestion des API.

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

subscriptionId
path True
  • string

Informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

Réponses

Name Type Description
200 OK

Le groupe spécifié est déjà associé au produit.

201 Created

Le groupe a été correctement associé au produit.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2.

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementCreateProductGroup

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groups/templateGroup?api-version=2021-01-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup",
  "type": "Microsoft.ApiManagement/service/products/groups",
  "name": "templateGroup",
  "properties": {
    "displayName": "Template Group",
    "description": "group created via Template",
    "builtIn": false,
    "type": "custom"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup",
  "type": "Microsoft.ApiManagement/service/products/groups",
  "name": "templateGroup",
  "properties": {
    "displayName": "Template Group",
    "description": "group created via Template",
    "builtIn": false,
    "type": "custom"
  }
}

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GroupContract

Détails du contrat.

GroupType

Type de groupe.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

La liste des champs non valides est envoyée dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

GroupContract

Détails du contrat.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.builtIn
  • boolean

true si le groupe est l’un des trois groupes système (administrateurs, développeurs ou invités); Sinon, false.

properties.description
  • string

Description de groupe. Peut contenir des balises au format HTML.

properties.displayName
  • string

Nom de groupe.

properties.externalId
  • string

Pour les groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id> ; sinon, la valeur est null.

properties.type

Type de groupe.

type
  • string

Type de ressource pour la ressource gestion des API.

GroupType

Type de groupe.

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