New-AzApiManagementApi
Erstellt eine 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>]
Beschreibung
Das Cmdlet New-AzApiManagementApi erstellt eine Azure API-Verwaltungs-API.
Beispiele
Beispiel 1: Erstellen einer 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"
Dieser Befehl erstellt eine API mit dem Namen EchoApi mit der angegebenen URL.
Beispiel 2: Erstellen einer API durch Kopieren aller Vorgänge, Tags, Produkte und Richtlinien aus der Echo-API und in ein 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
Dieser Befehl erstellt eine API echoapiv3
in ApiVersionSet xmsVersionSet
und kopiert alle Vorgänge, Tags und Richtlinien aus der Quell-API echo-api
. Er setzt die Protokolle SubscriptionRequired, ServiceUrl, Path, Protocol außer Kraft.
Beispiel 3
Erstellt eine API. (automatisch generiert)
New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'
Parameter
-ApiId
Gibt die ID der zu erstellenden API an. Wenn Sie diesen Parameter nicht angeben, generiert dieses Cmdlet eine ID für Sie.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiType
Typ der zu erstellenden API (http, Soap, Websocket, graphql). Dieser Parameter ist optional.
Typ: | Nullable<T>[PsApiManagementApiType] |
Zulässige Werte: | Http, Soap, WebSocket, GraphQL |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersion
Api-Version der zu erstellenden API. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionDescription
Api-Versionsbeschreibung. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionSetId
Ein Ressourcenbezeichner für den zugehörigen API-Versionssatz. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationScope
Gibt den OAuth-Operationsbereich an. Der Standardwert ist $Null.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationServerId
Gibt die OAuth-Autorisierungsserver-ID an. Der Standardwert ist $Null. Sie müssen diesen Parameter angeben, wenn AuthorizationScope angegeben ist.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-BearerTokenSendingMethod
OpenId-Autorisierungsservermechanismus, mit dem Zugriffstoken an die API übergeben wird. Lesen Sie https://datatracker.ietf.org/doc/html/rfc6749#section-4. Dieser Parameter ist optional. Der Standardwert ist $null.
Typ: | String[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactEmail
Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactName
Der identifizierende Name der Kontaktperson/Organisation. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactUrl
Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Context
Gibt ein PsApiManagementContext -Objekt an.
Typ: | PsApiManagementContext |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.
Typ: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Gibt eine Beschreibung für die Web-API an.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseName
Der für die API verwendete Lizenzname. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseUrl
Eine URL zu den Nutzungsbedingungen für die API. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Gibt den Namen der Web-API an. Dies ist der öffentliche Name der API, wie sie in den Entwickler- und Administratorportalen angezeigt wird.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OpenIdProviderId
OpenId-Autorisierungsserverbezeichner. Dieser Parameter ist optional. Der Standardwert ist $null. Muss angegeben werden, wenn BearerTokenSendingMethods angegeben ist.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Gibt den Web-API-Pfad an, der der letzte Teil der öffentlichen URL der API ist und dem Web-API-Suffixfeld im Verwaltungsportal entspricht. Diese URL wird von API-Consumern verwendet, um Anforderungen an den Webdienst zu senden und muss ein bis 400 Zeichen lang sein. Der Standardwert ist $Null.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductIds
Gibt ein Array von Produkt-IDs an, dem die neue API hinzugefügt werden soll.
Typ: | String[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Protocols
Gibt ein Array von Web-API-Protokollen an. Gültige Werte sind http, https. Dies sind die Webprotokolle, über die die API verfügbar gemacht wird. Der Standardwert ist $Null.
Typ: | PsApiManagementSchema[] |
Zulässige Werte: | Http, Https, Ws, Wss |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ServiceUrl
Gibt die URL des Webdiensts an, der die API verfügbar macht. Diese URL wird nur von Azure API Management verwendet und wird nicht öffentlich gemacht. Die URL muss ein bis 2000 Zeichen lang sein.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiId
API-ID der Quell-API. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiRevision
API-Revision der Quell-API. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Gibt den Kopfzeilennamen des Abonnementschlüssels an. Der Standardwert ist $Null.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
Gibt den Namen des Abfragezeichenfolgenparameters des Abonnementschlüssels an. Der Standardwert ist $Null.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionRequired
Flag zum Erzwingen von SubscriptionRequired für Anforderungen an die API. Dieser Parameter ist optional.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TermsOfServiceUrl
Eine URL zu den Nutzungsbedingungen für die API. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Eingaben
String[]
Ausgaben
Ähnliche Themen
Azure PowerShell
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für