New-AzApiManagementApi

Odwołanie

Moduł:: Az.ApiManagement

Tworzy interfejs API.

Składnia

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

Opis

Polecenie cmdlet New-AzApiManagementApi tworzy interfejs API usługi Azure API Management.

Przykłady

Przykład 1. Tworzenie interfejsu 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"

To polecenie tworzy interfejs API o nazwie EchoApi z określonym adresem URL.

Przykład 2: Tworzenie interfejsu API przez skopiowanie wszystkich operacji, tagów, produktów i zasad z interfejsu echo-api oraz do elementu 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

To polecenie tworzy echoapiv3 interfejsu API w xmsVersionSet ApiVersionSet i kopiuje wszystkie operacje, tagi i zasady ze źródłowego interfejsu API echo-api. Zastępuje ona element SubscriptionRequired, ServiceUrl, Path, Protocols

Przykład 3

Tworzy interfejs API. (automatycznie wygenerowane)

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

Parametry

-ApiId

Określa identyfikator interfejsu API do utworzenia. Jeśli nie określisz tego parametru, to polecenie cmdlet generuje identyfikator.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiType

Typ interfejsu API do utworzenia (http, soap, websocket, graphql). Ten parametr jest opcjonalny.

Typ:	Nullable<T>[PsApiManagementApiType]
Dopuszczalne wartości:	Http, Soap, WebSocket, GraphQL
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiVersion

Wersja interfejsu API do utworzenia. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiVersionDescription

Opis wersji interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiVersionSetId

Identyfikator zasobu powiązanego zestawu wersji interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-AuthorizationScope

Określa zakres operacji OAuth. Wartość domyślna to $Null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-AuthorizationServerId

Określa identyfikator serwera autoryzacji OAuth. Wartość domyślna to $Null. Należy określić ten parametr, jeśli określono AuthorizationScope.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-BearerTokenSendingMethod

Mechanizm serwera autoryzacji OpenId, za pomocą którego token dostępu jest przekazywany do interfejsu API. Zapoznaj się z https://datatracker.ietf.org/doc/html/rfc6749#section-4. Ten parametr jest opcjonalny. Wartość domyślna to $null.

Typ:	String[]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ContactEmail

Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ContactName

Nazwa identyfikująca osoby kontaktowej/organizacji. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ContactUrl

Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Context

Określa obiekt PsApiManagementContext.

Typ:	PsApiManagementContext
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:	IAzureContextContainer
Aliasy:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Description

Określa opis internetowego interfejsu API.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-LicenseName

Nazwa licencji używana dla interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-LicenseUrl

Adres URL warunków użytkowania usługi dla interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Name

Określa nazwę internetowego interfejsu API. Jest to publiczna nazwa interfejsu API wyświetlana w portalach deweloperskich i administracyjnych.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-OpenIdProviderId

Identyfikator serwera autoryzacji OpenId. Ten parametr jest opcjonalny. Wartość domyślna to $null. Należy określić, jeśli określono element BearerTokenSendingMethods.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Path

Określa ścieżkę internetowego interfejsu API, która jest ostatnią częścią publicznego adresu URL interfejsu API i odpowiada polu sufiksu adresu URL internetowego interfejsu API w portalu administracyjnym. Ten adres URL jest używany przez użytkowników interfejsu API do wysyłania żądań do usługi internetowej i musi mieć długość od 400 znaków. Wartość domyślna to $Null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ProductIds

Określa tablicę identyfikatorów produktów, do której ma zostać dodany nowy interfejs API.

Typ:	String[]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Protocols

Określa tablicę protokołów internetowego interfejsu API. Prawidłowe wartości to http, https. Są to protokoły internetowe, za pośrednictwem których udostępniono interfejs API. Wartość domyślna to $Null.

Typ:	PsApiManagementSchema[]
Dopuszczalne wartości:	Http, Https, Ws, Wss
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ServiceUrl

Określa adres URL usługi internetowej, która uwidacznia interfejs API. Ten adres URL jest używany tylko przez usługę Azure API Management i nie jest upubliczniony. Adres URL musi mieć długość od 2000 znaków.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SourceApiId

Identyfikator interfejsu API źródłowego. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SourceApiRevision

Poprawka interfejsu API źródłowego. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SubscriptionKeyHeaderName

Określa nazwę nagłówka klucza subskrypcji. Wartość domyślna to $Null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SubscriptionKeyQueryParamName

Określa nazwę parametru ciągu zapytania klucza subskrypcji. Wartość domyślna to $Null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SubscriptionRequired

Flaga wymuszania subskrypcjiWymagane dla żądań do interfejsu API. Ten parametr jest opcjonalny.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TermsOfServiceUrl

Adres URL warunków użytkowania usługi dla interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

Dane wyjściowe

PsApiManagementApi

Udostępnij za pośrednictwem

New-AzApiManagementApi

Składnia

Opis

Przykłady

Przykład 1. Tworzenie interfejsu API

Przykład 2: Tworzenie interfejsu API przez skopiowanie wszystkich operacji, tagów, produktów i zasad z interfejsu echo-api oraz do elementu ApiVersionSet

Przykład 3

Parametry

-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

Dane wejściowe

Dane wyjściowe

Dodatkowe zasoby

Udostępnij za pośrednictwem

New-AzApiManagementApi

Składnia

Opis

Przykłady

Przykład 1. Tworzenie interfejsu API

Przykład 2: Tworzenie interfejsu API przez skopiowanie wszystkich operacji, tagów, produktów i zasad z interfejsu echo-api oraz do elementu ApiVersionSet

Przykład 3

Parametry

-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

Dane wejściowe

Dane wyjściowe

Linki powiązane

Dodatkowe zasoby