Set-AzApiManagementApi

Modul:

Az.ApiManagement Module

Upraví rozhraní API.

Syntax

ExpandedParameter (Výchozí)

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

ByInputObject

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

ExpandedParameter

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-ApiType

Typ rozhraní API pro vytvoření (http, soap, websocket, graphql). Tento parametr je volitelný.

Vlastnosti parametru

Typ:	Nullable<T>[PsApiManagementApiType]
Default value:	None
Přípustné hodnoty:	Http, Soap, WebSocket, GraphQL
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-AuthorizationScope

Určuje obor operací OAuth. Výchozí hodnota je $Null.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	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 .

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-ContactEmail

E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-ContactName

Identifikační jméno kontaktní osoby nebo organizace. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-ContactUrl

Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-Context

Určuje PsApiManagementContext objektu.

Vlastnosti parametru

Typ:	PsApiManagementContext
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

ExpandedParameter

Position:	Named
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Vlastnosti parametru

Typ:	IAzureContextContainer
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	AzContext, AzureRmContext, AzureCredential

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Description

Určuje popis webového rozhraní API.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-InputObject

Instance of PsApiManagementApi. Tento parametr je povinný.

Vlastnosti parametru

Typ:	PsApiManagementApi
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

ByInputObject

Position:	Named
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-LicenseName

Název licence použitý pro rozhraní API. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-LicenseUrl

Adresa URL podmínek služby pro rozhraní API. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-Name

Určuje název webového rozhraní API.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-PassThru

passthru

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	PsApiManagementSchema[]
Default value:	None
Přípustné hodnoty:	Http, Https, Ws, Wss
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-ServiceUrl

Určuje adresu URL webové služby, která zveřejňuje rozhraní API. Tuto adresu URL používá pouze Azure API Management a není veřejná. Adresa URL musí mít délku 2 000 znaků.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-SubscriptionKeyHeaderName

Určuje název hlavičky klíče předplatného. Výchozí hodnota je $Null.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-SubscriptionKeyQueryParamName

Určuje název parametru řetězce dotazu klíče předplatného. Výchozí hodnota je $Null.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-SubscriptionRequired

Příznak pro vynucení subscriptionRequired pro požadavky na rozhraní API Tento parametr je volitelný.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-TermsOfServiceUrl

Adresa URL podmínek služby pro rozhraní API. Tento parametr je volitelný.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema

SwitchParameter

Výstupy

PsApiManagementApi

Související odkazy

• Export-AzApiManagementApi
• Get-AzApiManagementApi
• Import-AzApiManagementApi
• New-AzApiManagementApi
• Remove-AzApiManagementApi