Dela via

Set-AzApiManagementApi

  • Referens
Modul:
Az.ApiManagement

Ändrar ett 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>]

Description

Cmdleten Set-AzApiManagementApi ändrar ett Azure API Management-API.

Exempel

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

Exempel 2: Lägga till ett API i en befintlig 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

Det här exemplet lägger till ett API i en befintlig API-versionsuppsättning

Exempel 3: Ändra serverdelstjänstenUrl där API:et pekar på

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

I det här exemplet uppdateras ServiceUrl som echo-api pekar på.

Parametrar

-ApiId

Anger ID för API:et som ska ändras.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
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

-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-auktoriseringsserveridentifieraren. 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

-InputObject

Instans av PsApiManagementApi. Den här parametern krävs.

Typ:PsApiManagementApi
Position:Named
Standardvärde:None
Obligatorisk:True
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.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
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

-PassThru

passthru

Typ:SwitchParameter
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. 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:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Protocols

Anger en matris med webb-API-protokoll. psdx_paramvalues http och 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:False
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:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionKeyHeaderName

Anger namnet på prenumerationsnyckelrubriken. Standardvärdet är $Null.

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

-SubscriptionKeyQueryParamName

Anger namnet på frågesträngsparametern 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

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Utdata

PsApiManagementApi