Partager via


Workspace Api - Update

Met à jour l’API spécifiée de l’espace de travail dans une instance de service Gestion des API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?api-version=2023-09-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
apiId
path True

string

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 comme suffixe où n est le numéro de révision.

Modèle d’expression régulière: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

workspaceId
path True

string

Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.

Modèle d’expression régulière: ^[^*#&+:<>?]+$

api-version
query True

string

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
If-Match True

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom Type Description
properties.apiRevision

string

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée

properties.apiRevisionDescription

string

Description de la révision de l’API.

properties.apiVersion

string

Indique l’identificateur de version de l’API si l’API est avec version

properties.apiVersionDescription

string

Description de la version de l’API.

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 comporter des balises de mise en forme.

properties.displayName

string

Nom de l’API.

properties.isCurrent

boolean

Indique si la révision de l’API est la révision actuelle de l’API.

properties.license

ApiLicenseInformation

Informations de licence pour l’API.

properties.path

string

URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.

properties.protocols

Protocol[]

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

properties.serviceUrl

string

URL absolue du service principal qui implémente cette API.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protocoles sur lesquels l’API est mise à disposition.

properties.subscriptionRequired

boolean

Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.

properties.termsOfServiceUrl

string

URL des conditions d’utilisation de l’API. DOIT être au format d’une URL.

properties.type

ApiType

Type d’API.

Réponses

Nom Type Description
200 OK

ApiContract

L’API a été correctement mise à jour.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

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

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

ApiManagementUpdateWorkspaceApi

Exemple de requête

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api?api-version=2023-09-01-preview


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Définitions

Nom Description
ApiContactInformation

Informations de contact de l’API

ApiContract

Détails de l’API.

ApiLicenseInformation

Informations de licence d’API

ApiType

Type d’API.

ApiUpdateContract

Détails du contrat de mise à jour de l’API.

ApiVersionSetContractDetails

Un jeu de versions d’API contient la configuration courante d’un ensemble de versions d’API associées

AuthenticationSettingsContract

Paramètres d’authentification de l’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

Indique sur quels protocoles les opérations dans 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

Informations de contact de l’API

Nom Type Description
email

string

Adresse e-mail de la personne ou de l’organisation de contact. DOIT être au format d’une adresse e-mail

name

string

Nom d’identification de la personne ou de l’organisation de contact

url

string

URL pointant vers les informations de contact. DOIT être au format d’une URL

ApiContract

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

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée

properties.apiRevisionDescription

string

Description de la révision de l’API.

properties.apiVersion

string

Indique l’identificateur de version de l’API si l’API est avec version

properties.apiVersionDescription

string

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 comporter des balises de mise en forme.

properties.displayName

string

Nom de l’API. Doit comporter entre 1 et 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

URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.

properties.protocols

Protocol[]

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

properties.provisioningState

string

État d’approvisionnement

properties.serviceUrl

string

URL absolue du service principal qui implémente cette API. Ne peut pas avoir 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 mise à disposition.

properties.subscriptionRequired

boolean

Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.

properties.termsOfServiceUrl

string

URL des 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

Informations de 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

Type d’API.

Nom Type Description
graphql

string

grpc

string

http

string

odata

string

soap

string

websocket

string

ApiUpdateContract

Détails du contrat de mise à jour de l’API.

Nom Type Description
properties.apiRevision

string

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée

properties.apiRevisionDescription

string

Description de la révision de l’API.

properties.apiVersion

string

Indique l’identificateur de version de l’API si l’API est avec version

properties.apiVersionDescription

string

Description de la version de l’API.

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 comporter des balises de mise en forme.

properties.displayName

string

Nom de l’API.

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

URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.

properties.protocols

Protocol[]

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

properties.serviceUrl

string

URL absolue du service principal qui implémente cette API.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protocoles sur lesquels l’API est mise à disposition.

properties.subscriptionRequired

boolean

Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.

properties.termsOfServiceUrl

string

URL des conditions d’utilisation de l’API. DOIT être au format d’une URL.

properties.type

ApiType

Type d’API.

ApiVersionSetContractDetails

Un jeu de versions d’API contient la configuration courante d’un ensemble de versions d’API associées

Nom Type Description
description

string

Description de l’ensemble 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 de l’ensemble 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

Paramètres d’authentification de l’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

Comment envoyer un jeton au serveur.

Nom Type Description
authorizationHeader

string

Le jeton d’accès sera transmis dans l’en-tête d’autorisation à l’aide du schéma du porteur

query

string

Le jeton d’accès est transmis en tant que paramètres de requête.

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

OAuth2AuthenticationSettingsContract

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

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

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

Nom Type Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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

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

Nom Type Description
Header

string

La version de l’API est passée dans un en-tête HTTP.

Query

string

La version de l’API est passée dans un paramètre de requête.

Segment

string

La version de l’API est passée dans un segment de chemin d’accès.