New-AzApiManagementApi

Référence

Module:: Az.ApiManagement

Crée une API.

Syntaxe

New-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>]
   [-ProductIds <String[]>]
   [-SubscriptionRequired]
   [-ApiVersionDescription <String>]
   [-ApiVersionSetId <String>]
   [-ApiVersion <String>]
   [-SourceApiId <String>]
   [-SourceApiRevision <String>]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

L’applet de commande New-AzApiManagementApi crée une API Azure Gestion des API.

Exemples

Exemple 1 : Créer une API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"

Cette commande crée une API nommée EchoApi avec l’URL spécifiée.

Exemple 2 : Créer une API en copiant toutes les opérations, étiquettes, produits et stratégies d’écho-api et dans un ApiVersionSet

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"

ApiId                         : 691b7d410125414a929c108541c60e06
Name                          : echoapiv4
Description                   : Create Echo Api V4
ServiceUrl                    : https://echoapi.cloudapp.net/v4
Path                          : echov3
ApiType                       : http
Protocols                     : {Http, Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v4
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          : True
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Cette commande crée une API echoapiv3 dans ApiVersionSet xmsVersionSet et copie toutes les opérations, balises et stratégies à partir de l’API echo-apisource. Il remplace subscriptionRequired, ServiceUrl, Path, Protocols

Exemple 3

Crée une API. (généré automatiquement)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

Paramètres

-ApiId

Spécifie l’ID de l’API à créer. Si vous ne spécifiez pas ce paramètre, cette applet de commande génère un ID pour vous.

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

-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

-ApiVersion

Version d’API de l’API à créer. 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

-ApiVersionDescription

Description de la version 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

-ApiVersionSetId

Identificateur de ressource pour le jeu de versions d’API associé. 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

-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’ID 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

-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. Il s’agit du nom public de l’API tel qu’il apparaît sur les portails de développement et d’administration.

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

-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

-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 et correspond au champ suffixe URL de l’API web dans le portail d’administration. 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:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ProductIds

Spécifie un tableau d’ID de produit auquel ajouter la nouvelle API.

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. Les valeurs valides sont http, 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:	True
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:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SourceApiId

Identificateur d’API de l’API source. 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

-SourceApiRevision

Révision de l’API source. 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

-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

PsApiManagementSchema[]

String[]

Sorties

PsApiManagementApi

Partager via

New-AzApiManagementApi

Syntaxe

Description

Exemples

Exemple 1 : Créer une API

Exemple 2 : Créer une API en copiant toutes les opérations, étiquettes, produits et stratégies d’écho-api et dans un ApiVersionSet

Exemple 3

Paramètres

-ApiId

-ApiType

-ApiVersion

-ApiVersionDescription

-ApiVersionSetId

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-Path

-ProductIds

-Protocols

-ServiceUrl

-SourceApiId

-SourceApiRevision

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

Entrées

Sorties

Ressources supplémentaires

Partager via

New-AzApiManagementApi

Syntaxe

Description

Exemples

Exemple 1 : Créer une API

Exemple 2 : Créer une API en copiant toutes les opérations, étiquettes, produits et stratégies d’écho-api et dans un ApiVersionSet

Exemple 3

Paramètres

-ApiId

-ApiType

-ApiVersion

-ApiVersionDescription

-ApiVersionSetId

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-Path

-ProductIds

-Protocols

-ServiceUrl

-SourceApiId

-SourceApiRevision

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

Entrées

Sorties

Liens associés

Ressources supplémentaires