Set-AzApiManagementApi

  • Reference
Modul:
Az.ApiManagement

Upraví rozhraní API.

Syntaxe

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

Rutina Set-AzApiManagementApi upraví rozhraní API služby Azure API Management.

Příklady

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

Příklad 2: Přidání rozhraní API do existující sady 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

Tento příklad přidá rozhraní API do existující sady verzí rozhraní API.

Příklad 3: Změna adresy BACK-end ServiceUrl, na které rozhraní API ukazuje

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

Tento příklad aktualizuje serviceUrl odkazující echo-api na.

Parametry

-ApiId

Určuje ID rozhraní API, které se má upravit.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
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

-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 identifikátor 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

-InputObject

Instance of PsApiManagementApi. Tento parametr je povinný.

Typ:PsApiManagementApi
Position:Named
Default value:None
Vyžadováno:True
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.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
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

-PassThru

passthru

Typ:SwitchParameter
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. 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:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Protocols

Určuje pole protokolů webového rozhraní API. psdx_paramvalues http a 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:False
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: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

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Výstupy

PsApiManagementApi