Partager via

Set-AzApiManagementApi

  • Référence
Module:
Az.ApiManagement

Modifie une API.

Syntaxe

Set-AzApiManagementApi
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementApi
   -InputObject <PsApiManagementApi>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

L’applet de commande Set-AzApiManagementApi modifie une API Azure Gestion des API.

Exemples

Exemple 1 : Modifier une API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"

Exemple 2 : Ajouter une API à un ApiVersionSet existant

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThru

Cet exemple ajoute une API à un jeu de versions d’API existant

Exemple 3 : Modifier le ServiceUrl principal où l’API pointe vers

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

Cet exemple met à jour le ServiceUrl vers echo-api qui pointe.

Paramètres

-ApiId

Spécifie l’ID de l’API à modifier.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ApiType

Type d’API à créer (http, soap, websocket, graphql). Ce paramètre est facultatif.

Type:Nullable<T>[PsApiManagementApiType]
Valeurs acceptées:Http, Soap, WebSocket, GraphQL
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-AuthorizationScope

Spécifie l’étendue des opérations OAuth. La valeur par défaut est $Null.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-AuthorizationServerId

Spécifie l’identificateur du serveur d’autorisation OAuth. La valeur par défaut est $Null. Vous devez spécifier ce paramètre si AuthorizationScope est spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-BearerTokenSendingMethod

Mécanisme de serveur d’autorisation OpenId par lequel le jeton d’accès est passé à l’API. Consultez la page https://datatracker.ietf.org/doc/html/rfc6749#section-4. Ce paramètre est facultatif. La valeur par défaut est $null.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ContactEmail

Adresse e-mail de la personne/de l’organisation de contact. DOIT être au format d’une adresse e-mail. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ContactName

Nom d’identification de la personne/de l’organisation de contact. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ContactUrl

URL pointant vers les informations de contact. DOIT être au format d’une URL. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Context

Spécifie un objet PsApiManagementContext .

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

Spécifie une description de l’API web.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-InputObject

Instance de PsApiManagementApi. Ce paramètre est obligatoire.

Type:PsApiManagementApi
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-LicenseName

Nom de licence utilisé pour l’API. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-LicenseUrl

URL vers les conditions d’utilisation de l’API. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom de l’API web.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-OpenIdProviderId

Identificateur du serveur d’autorisation OpenId. Ce paramètre est facultatif. La valeur par défaut est $null. Doit être spécifié si BearerTokenSendingMethods est spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès de l’API web, qui est la dernière partie de l’URL publique de l’API. Cette URL est utilisée par les consommateurs d’API pour envoyer des demandes au service web, et doit avoir une à 400 caractères. La valeur par défaut est $Null.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Protocols

Spécifie un tableau de protocoles d’API web. psdx_paramvalues http et https. Il s’agit des protocoles web sur lesquels l’API est rendue disponible. La valeur par défaut est $Null.

Type:PsApiManagementSchema[]
Valeurs acceptées:Http, Https, Ws, Wss
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ServiceUrl

Spécifie l’URL du service web qui expose l’API. Cette URL est utilisée uniquement par Azure Gestion des API et n’est pas rendue publique. L’URL doit être de 1 à 2 000 caractères.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SubscriptionKeyHeaderName

Spécifie le nom de l’en-tête de clé d’abonnement. La valeur par défaut est $Null.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SubscriptionKeyQueryParamName

Spécifie le nom du paramètre de chaîne de requête de clé d’abonnement. La valeur par défaut est $Null.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SubscriptionRequired

Indicateur pour appliquer SubscriptionRequired pour les demandes adressées à l’API. Ce paramètre est facultatif.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TermsOfServiceUrl

URL vers les conditions d’utilisation de l’API. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Sorties

PsApiManagementApi