Condividi tramite

New-AzApiManagementApi

  • Riferimento
Modulo:
Az.ApiManagement

Crea un'API.

Sintassi

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>]

Descrizione

Il cmdlet New-AzApiManagementApi crea un'API di Gestione API di Azure.

Esempio

Esempio 1: Creare un'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"

Questo comando crea un'API denominata EchoApi con l'URL specificato.

Esempio 2: Creare un'API copiando tutte le operazioni, tag, prodotti e criteri da echo-api e in un oggetto 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

Questo comando crea un echoapiv3 API in ApiVersionSet xmsVersionSet e copia tutte le operazioni, tag e criteri dall'API di origine echo-api. Esegue l'override di SubscriptionRequired, ServiceUrl, Path, Protocols

Esempio 3

Crea un'API. (generato automaticamente)

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

Parametri

-ApiId

Specifica l'ID dell'API da creare. Se non si specifica questo parametro, questo cmdlet genera automaticamente un ID.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ApiType

Tipo di API da creare (http, soap, websocket, graphql). Questo parametro è facoltativo.

Tipo:Nullable<T>[PsApiManagementApiType]
Valori accettati:Http, Soap, WebSocket, GraphQL
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ApiVersion

Versione api dell'API da creare. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ApiVersionDescription

Descrizione della versione dell'API. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ApiVersionSetId

Identificatore di risorsa per il set di versioni dell'API correlato. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-AuthorizationScope

Specifica l'ambito delle operazioni OAuth. Il valore predefinito è $Null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-AuthorizationServerId

Specifica l'ID server di autorizzazione OAuth. Il valore predefinito è $Null. È necessario specificare questo parametro se viene specificato authorizationScope.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-BearerTokenSendingMethod

Meccanismo del server di autorizzazione OpenId tramite il quale viene passato il token di accesso all'API. Fare riferimento a https://datatracker.ietf.org/doc/html/rfc6749#section-4. Questo parametro è facoltativo. Il valore predefinito è $null.

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ContactEmail

Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ContactName

Nome di identificazione della persona o dell'organizzazione di contatto. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ContactUrl

URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Context

Specifica un oggetto PsApiManagementContext .

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Description

Specifica una descrizione per l'API Web.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-LicenseName

Nome della licenza usato per l'API. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-LicenseUrl

URL delle condizioni di servizio per l'API. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Specifica il nome dell'API Web. Si tratta del nome pubblico dell'API così come viene visualizzato nei portali di sviluppo e amministrazione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-OpenIdProviderId

Identificatore del server di autorizzazione OpenId. Questo parametro è facoltativo. Il valore predefinito è $null. Deve essere specificato se è specificato BearerTokenSendingMethods.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Path

Specifica il percorso dell'API Web, che è l'ultima parte dell'URL pubblico dell'API e corrisponde al campo suffisso URL API Web nel portale di amministrazione. Questo URL viene usato dai consumer dell'API per inviare richieste al servizio Web e deve avere una lunghezza di 400 caratteri. Il valore predefinito è $Null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ProductIds

Specifica una matrice di ID prodotto a cui aggiungere la nuova API.

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Protocols

Specifica una matrice di protocolli API Web. I valori validi sono http, https. Si tratta dei protocolli Web su cui viene resa disponibile l'API. Il valore predefinito è $Null.

Tipo:PsApiManagementSchema[]
Valori accettati:Http, Https, Ws, Wss
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ServiceUrl

Specifica l'URL del servizio Web che espone l'API. Questo URL viene usato solo da Gestione API di Azure e non viene reso pubblico. L'URL deve avere una lunghezza di 2000 caratteri.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SourceApiId

Identificatore api dell'API di origine. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SourceApiRevision

Revisione api dell'API di origine. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SubscriptionKeyHeaderName

Specifica il nome dell'intestazione della chiave di sottoscrizione. Il valore predefinito è $Null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SubscriptionKeyQueryParamName

Specifica il nome del parametro della stringa di query della chiave di sottoscrizione. Il valore predefinito è $Null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SubscriptionRequired

Flag per applicare SubscriptionRequired per le richieste all'API. Questo parametro è facoltativo.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-TermsOfServiceUrl

URL delle condizioni di servizio per l'API. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

Input

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

Output

PsApiManagementApi