Freigeben über

Set-AzApiManagementApi

  • Referenz
Modul:
Az.ApiManagement

Ändert eine API.

Syntax

Set-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>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementApi
   -InputObject <PsApiManagementApi>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzApiManagementApi ändert eine Azure API-Verwaltungs-API.

Beispiele

Beispiel 1: Ändern einer API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"

Beispiel 2: Hinzufügen einer API zu einem vorhandenen ApiVersionSet

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThru

In diesem Beispiel wird einem vorhandenen API-Versionssatz eine API hinzugefügt.

Beispiel 3: Ändern des Back-End-ServiceUrl, auf den die API verweist

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

In diesem Beispiel wird der ServiceUrl aktualisiert, auf den die echo-api Datei verweist.

Parameter

-ApiId

Gibt die ID der zu ändernden API an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AuthorizationScope

Gibt den OAuth-Operationsbereich an. Der Standardwert ist $Null.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AuthorizationServerId

Gibt den OAuth-Autorisierungsserverbezeichner an. Der Standardwert ist $Null. Sie müssen diesen Parameter angeben, wenn AuthorizationScope angegeben ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ContactName

Der identifizierende Name der Kontaktperson/Organisation. Dieser Parameter ist optional.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Context

Gibt ein PsApiManagementContext -Objekt an.

Typ:PsApiManagementContext
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt eine Beschreibung für die Web-API an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-InputObject

Instanz von PsApiManagementApi. Dieser Parameter ist erforderlich.

Typ:PsApiManagementApi
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LicenseName

Der für die API verwendete Lizenzname. Dieser Parameter ist optional.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LicenseUrl

Eine URL zu den Nutzungsbedingungen für die API. Dieser Parameter ist optional.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Namen der Web-API an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Path

Gibt den Web-API-Pfad an, der der letzte Teil der öffentlichen URL der API ist. 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:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Protocols

Gibt ein Array von Web-API-Protokollen an. psdx_paramvalues http und 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:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SubscriptionKeyHeaderName

Gibt den Namen des Abonnementschlüsselheaders an. Der Standardwert ist $Null.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SubscriptionKeyQueryParamName

Gibt den Namen des Abfragezeichenfolgenparameters des Abonnementschlüssels an. Der Standardwert ist $Null.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren: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
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TermsOfServiceUrl

Eine URL zu den Nutzungsbedingungen für die API. Dieser Parameter ist optional.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Ausgaben

PsApiManagementApi