Product Api - Create Or Update

Service:: API Management

Version d'API:: 2024-05-01

Ajoute une API au produit spécifié.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}?api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
productId	path	True	string minLength: 1 maxLength: 256	Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ApiContract	L’API spécifiée est déjà ajoutée au produit.
201 Created	ApiContract	L’API a été ajoutée au produit.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

ApiManagementCreateProductApi

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apis/echo-api?api-version=2024-05-01

Exemple de réponse

Code d’état:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Définitions

Nom	Description
ApiContactInformation	Informations de contact de l’API
ApiContract	Détails de l’API.
ApiLicenseInformation	Informations sur la licence d’API
ApiType	Type d’API.
ApiVersionSetContractDetails	Un jeu de versions d’API contient la configuration commune d’un ensemble de versions d’API relatives
AuthenticationSettingsContract	Paramètres d’authentification d’API.
bearerTokenSendingMethods	Comment envoyer un jeton au serveur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
OAuth2AuthenticationSettingsContract	Détails des paramètres d’authentification OAuth2 de l’API.
OpenIdAuthenticationSettingsContract	Détails des paramètres d’authentification OAuth2 de l’API.
Protocol	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.
SubscriptionKeyParameterNamesContract	Détails des noms de paramètres de clé d’abonnement.
versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

ApiContactInformation

Object

Informations de contact de l’API

Nom	Type	Description
email	string	Adresse e-mail de la personne/de l’organisation de contact. DOIT être au format d’une adresse e-mail
name	string	Nom d’identification de la personne/de l’organisation de contact
url	string	URL pointant vers les informations de contact. DOIT être au format d’une URL

ApiContract

Object

Détails de l’API.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.apiRevision	string minLength: 1 maxLength: 100	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée
properties.apiRevisionDescription	string maxLength: 256	Description de la révision de l’API.
properties.apiVersion	string maxLength: 100	Indique l’identificateur de version de l’API si l’API est versionnée
properties.apiVersionDescription	string maxLength: 256	Description de la version de l’API.
properties.apiVersionSet	ApiVersionSetContractDetails	Détails du jeu de versions
properties.apiVersionSetId	string	Identificateur de ressource pour l’ApiVersionSet associé.
properties.authenticationSettings	AuthenticationSettingsContract	Collection de paramètres d’authentification inclus dans cette API.
properties.contact	ApiContactInformation	Informations de contact pour l’API.
properties.description	string	Description de l’API. Peut inclure des balises de mise en forme HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nom de l’API. Doit être de 1 à 300 caractères.
properties.isCurrent	boolean	Indique si la révision de l’API est la révision actuelle de l’API.
properties.isOnline	boolean	Indique si la révision de l’API est accessible via la passerelle.
properties.license	ApiLicenseInformation	Informations de licence pour l’API.
properties.path	string minLength: 0 maxLength: 400	URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.
properties.protocols	Protocol[]	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.
properties.provisioningState	string	État d’approvisionnement
properties.serviceUrl	string minLength: 0 maxLength: 2000	URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.
properties.sourceApiId	string	Identificateur d’API de l’API source.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocoles sur lesquels l’API est rendue disponible.
properties.subscriptionRequired	boolean	Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.
properties.termsOfServiceUrl	string	URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.
properties.type	ApiType	Type d’API.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ApiLicenseInformation

Object

Informations sur la licence d’API

Nom	Type	Description
name	string	Nom de licence utilisé pour l’API
url	string	URL de la licence utilisée pour l’API. DOIT être au format d’une URL

ApiType

Énumération

Type d’API.

Valeur	Description
http
soap
websocket
graphql
odata
grpc

ApiVersionSetContractDetails

Object

Un jeu de versions d’API contient la configuration commune d’un ensemble de versions d’API relatives

Nom	Type	Description
description	string	Description du jeu de versions d’API.
id	string	Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.
name	string	Nom complet du jeu de versions de l’API.
versionHeaderName	string	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur `header`.
versionQueryName	string	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur `query`.
versioningScheme	versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

AuthenticationSettingsContract

Object

Paramètres d’authentification d’API.

Nom	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	Paramètres d’authentification OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Collection de paramètres d’authentification OAuth2 inclus dans cette API.
openid	OpenIdAuthenticationSettingsContract	Paramètres d’authentification OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Collection de paramètres d’authentification Open ID Connect inclus dans cette API.

bearerTokenSendingMethods

Énumération

Comment envoyer un jeton au serveur.

Valeur	Description
authorizationHeader	Le jeton d’accès est transmis dans l’en-tête d’autorisation à l’aide du schéma du porteur
query	Le jeton d’accès est transmis en tant que paramètres de requête.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

OAuth2AuthenticationSettingsContract

Object

Détails des paramètres d’authentification OAuth2 de l’API.

Nom	Type	Description
authorizationServerId	string	Identificateur du serveur d’autorisation OAuth.
scope	string	étendue des opérations.

OpenIdAuthenticationSettingsContract

Object

Détails des paramètres d’authentification OAuth2 de l’API.

Nom	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Comment envoyer un jeton au serveur.
openidProviderId	string	Identificateur du serveur d’autorisation OAuth.

Protocol

Énumération

Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.

Valeur	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Détails des noms de paramètres de clé d’abonnement.

Nom	Type	Description
header	string	Nom de l’en-tête de clé d’abonnement.
query	string	Nom du paramètre de chaîne de requête de clé d’abonnement.

versioningScheme

Énumération

Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

Valeur	Description
Segment	La version de l’API est passée dans un segment de chemin d’accès.
Query	La version de l’API est passée dans un paramètre de requête.
Header	La version de l’API est transmise dans un en-tête HTTP.

Partager via

Product Api - Create Or Update

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementCreateProductApi

Exemple de requête

Exemple de réponse

Définitions

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme