Dela via

New-AzApiManagementApi

  • Referens
Modul:
Az.ApiManagement

Skapar ett API.

Syntax

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

Cmdleten New-AzApiManagementApi skapar ett Azure API Management-API.

Exempel

Exempel 1: Skapa ett 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"

Det här kommandot skapar ett API med namnet EchoApi med den angivna URL:en.

Exempel 2: Skapa ett API genom att kopiera alla åtgärder, taggar, produkter och principer från echo-api och till en 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

Det här kommandot skapar en API-echoapiv3 i ApiVersionSet xmsVersionSet och kopierar alla åtgärder, taggar och principer från api-källan echo-api. Den åsidosätter SubscriptionRequired, ServiceUrl, Path, Protocols

Exempel 3

Skapar ett API. (automatiskt genererad)

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

Parametrar

-ApiId

Anger ID för API:et som ska skapas. Om du inte anger den här parametern genererar den här cmdleten ett ID åt dig.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiType

Typ av API som ska skapas (http, soap, websocket, graphql). Den här parametern är valfri.

Typ:Nullable<T>[PsApiManagementApiType]
Godkända värden:Http, Soap, WebSocket, GraphQL
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiVersion

Api-version av API:et som ska skapas. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiVersionDescription

Beskrivning av API-version. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiVersionSetId

En resursidentifierare för den relaterade API-versionsuppsättningen. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationScope

Anger omfånget för OAuth-åtgärder. Standardvärdet är $Null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationServerId

Anger OAuth-auktoriseringsserverns ID. Standardvärdet är $Null. Du måste ange den här parametern om AuthorizationScope har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-BearerTokenSendingMethod

OpenId-auktoriseringsservermekanism med vilken åtkomsttoken skickas till API:et. Se https://datatracker.ietf.org/doc/html/rfc6749#section-4. Den här parametern är valfri. Standardvärdet är $null.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ContactEmail

Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ContactName

Namnet på kontaktpersonen/organisationen. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ContactUrl

URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Context

Anger ett PsApiManagementContext- objekt.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Description

Anger en beskrivning för webb-API:et.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-LicenseName

Licensnamnet som används för API:et. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-LicenseUrl

En URL till användningsvillkoren för API:et. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Anger namnet på webb-API:et. Det här är det offentliga namnet på API:et så som det visas på utvecklar- och administratörsportalerna.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-OpenIdProviderId

OpenId-auktoriseringsserveridentifierare. Den här parametern är valfri. Standardvärdet är $null. Måste anges om BearerTokenSendingMethods har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Path

Anger webb-API-sökvägen, som är den sista delen av API:ets offentliga URL och motsvarar fältet Webb-API-URL-suffix i administratörsportalen. Den här URL:en används av API-konsumenter för att skicka begäranden till webbtjänsten och måste vara en till 400 tecken lång. Standardvärdet är $Null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ProductIds

Anger en matris med produkt-ID:n som det nya API:et ska läggas till i.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Protocols

Anger en matris med webb-API-protokoll. Giltiga värden är http, https. Det här är de webbprotokoll som API:et görs tillgängligt för. Standardvärdet är $Null.

Typ:PsApiManagementSchema[]
Godkända värden:Http, Https, Ws, Wss
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ServiceUrl

Anger URL:en för webbtjänsten som exponerar API:et. Den här URL:en används endast av Azure API Management och görs inte offentlig. URL:en måste vara mellan 1 och 2 000 tecken lång.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SourceApiId

API-identifierare för käll-API:et. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SourceApiRevision

Api Revision av käll-API:et. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionKeyHeaderName

Anger namnet på prenumerationsnyckelns huvud. Standardvärdet är $Null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionKeyQueryParamName

Anger parameternamnet för frågesträngen för prenumerationsnyckeln. Standardvärdet är $Null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionRequired

Flagga för att framtvinga SubscriptionRequired för begäranden till API:et. Den här parametern är valfri.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-TermsOfServiceUrl

En URL till användningsvillkoren för API:et. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

Indata

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

Utdata

PsApiManagementApi