Partager via

New-AzApiManagementApiSchema

  • Référence
Module:
Az.ApiManagement

Crée le schéma d’API dans le service ApiManagement

Syntaxe

New-AzApiManagementApiSchema
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-SchemaId <String>]
   -SchemaDocumentContentType <String>
   -SchemaDocument <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzApiManagementApiSchema
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-SchemaId <String>]
   -SchemaDocumentContentType <String>
   -SchemaDocumentFilePath <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Crée le nouveau schéma d’API de l’API.

Exemples

Exemple 1 : Créer un schéma pour l’API Étendue Swagger Petstore

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
New-AzApiManagementApiSchema -Context $context -ApiId swagger-petstore-extensive -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json

Schema Id                            Api Id                     Schema ContentType
---------                            ------                     ------------------
3e8892eb-98e4-408d-b77a-f424185c1044 swagger-petstore-extensive swaggerdefinition

L’applet de commande New-AzApiManagementApiSchema crée ou met à jour le schéma du swagger-petstore-extensive aPI.

Paramètres

-ApiId

Identificateur de l’API. Ce paramètre est requis.

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

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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

-Context

Instance de PsApiManagementContext. Ce paramètre est requis.

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

-SchemaDocument

Document de schéma d’API sous forme de chaîne. Ce paramètre est obligatoire -SchemaDocumentFile n’est pas spécifié.

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

-SchemaDocumentContentType

ContentType du schéma d’API. Ce paramètre est requis.

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

-SchemaDocumentFilePath

Chemin d’accès du fichier de document de schéma d’API. Ce paramètre est obligatoire -SchemaDocument n’est pas spécifié.

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

-SchemaId

Identificateur du nouveau schéma. Ce paramètre est facultatif. Si aucune valeur n’est spécifiée, elle est générée.

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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

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

Entrées

PsApiManagementContext

String

Sorties

PsApiManagementApiSchema