New-AzApiManagementApi

  • Reference
Modul:
Az.ApiManagement

Vytvoří rozhraní 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

Rutina New-AzApiManagementApi vytvoří rozhraní API služby Azure API Management.

Příklady

Příklad 1: Vytvoření rozhraní 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"

Tento příkaz vytvoří rozhraní API s názvem EchoApi se zadanou adresou URL.

Příklad 2: Vytvoření rozhraní API zkopírováním všech operací, značek, produktů a zásad z echo-api a do sady 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

Tento příkaz vytvoří rozhraní API v apiVersionSet echoapiv3 xmsVersionSet a zkopíruje všechny operace, značky a zásady ze zdrojového rozhraní API echo-api. Přepíše PředplatnéRequired, ServiceUrl, Path, Protokoly.

Příklad 3

Vytvoří rozhraní API. (automaticky vygenerováno)

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

Parametry

-ApiId

Určuje ID rozhraní API, které se má vytvořit. Pokud tento parametr nezadáte, tato rutina za vás vygeneruje ID.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApiType

Typ rozhraní API pro vytvoření (http, soap, websocket, graphql). Tento parametr je volitelný.

Typ:Nullable<T>[PsApiManagementApiType]
Přípustné hodnoty:Http, Soap, WebSocket, GraphQL
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApiVersion

Verze rozhraní API, která se má vytvořit. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApiVersionDescription

Popis verze rozhraní API Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApiVersionSetId

Identifikátor prostředku pro související sadu verzí rozhraní API. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-AuthorizationScope

Určuje obor operací OAuth. Výchozí hodnota je $Null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-AuthorizationServerId

Určuje ID autorizačního serveru OAuth. Výchozí hodnota je $Null. Tento parametr je nutné zadat, pokud je zadán AuthorizationScope .

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-BearerTokenSendingMethod

Mechanismus autorizačního serveru OpenId, pomocí kterého se přístupový token předává rozhraní API. Odkazovat na https://datatracker.ietf.org/doc/html/rfc6749#section-4. Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ContactEmail

E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ContactName

Identifikační jméno kontaktní osoby nebo organizace. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ContactUrl

Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Context

Určuje PsApiManagementContext objektu.

Typ:PsApiManagementContext
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Description

Určuje popis webového rozhraní API.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-LicenseName

Název licence použitý pro rozhraní API. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-LicenseUrl

Adresa URL podmínek služby pro rozhraní API. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Určuje název webového rozhraní API. Toto je veřejný název rozhraní API, jak se zobrazuje na portálech pro vývojáře a správce.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-OpenIdProviderId

Identifikátor autorizačního serveru OpenId Tento parametr je volitelný. Výchozí hodnota je $null. Je nutné zadat, pokud je zadán bearerTokenSendingMethods.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Path

Určuje cestu webového rozhraní API, což je poslední část veřejné adresy URL rozhraní API a odpovídá poli přípony adresy URL webového rozhraní API na portálu pro správu. Tuto adresu URL používají příjemci rozhraní API k odesílání požadavků do webové služby a musí mít délku 400 znaků. Výchozí hodnota je $Null.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ProductIds

Určuje pole ID produktů, do kterých se má přidat nové rozhraní API.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Protocols

Určuje pole protokolů webového rozhraní API. Platné hodnoty jsou http, https. Jedná se o webové protokoly, u kterých je rozhraní API dostupné. Výchozí hodnota je $Null.

Typ:PsApiManagementSchema[]
Přípustné hodnoty:Http, Https, Ws, Wss
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ServiceUrl

Určuje adresu URL webové služby, která zveřejňuje rozhraní API. Tuto adresu URL používá jenom Azure API Management a není veřejná. Adresa URL musí mít délku 2 000 znaků.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SourceApiId

Identifikátor rozhraní API zdrojového rozhraní API. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SourceApiRevision

Revize rozhraní API zdrojového rozhraní API Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionKeyHeaderName

Určuje název hlavičky klíče předplatného. Výchozí hodnota je $Null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionKeyQueryParamName

Určuje název parametru řetězce dotazu klíče předplatného. Výchozí hodnota je $Null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionRequired

Příznak pro vynucení subscriptionRequired pro požadavky na rozhraní API Tento parametr je volitelný.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-TermsOfServiceUrl

Adresa URL podmínek služby pro rozhraní API. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

Vstupy

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

Výstupy

PsApiManagementApi