Udostępnij za pośrednictwem

Set-AzApiManagementApi

  • Odwołanie
Moduł:
Az.ApiManagement

Modyfikuje interfejs API.

Składnia

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

Opis

Polecenie cmdlet Set-AzApiManagementApi modyfikuje interfejs API usługi Azure API Management.

Przykłady

Przykład 1. Modyfikowanie interfejsu 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"

Przykład 2. Dodawanie interfejsu API do istniejącego zestawu 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

W tym przykładzie dodano interfejs API do istniejącego zestawu wersji interfejsu API

Przykład 3. Zmiana elementu ServiceUrl zaplecza, na którym wskazuje interfejs API

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

W tym przykładzie usługa ServiceUrl wskazuje echo-api.

Parametry

-ApiId

Określa identyfikator interfejsu API do zmodyfikowania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ApiType

Typ interfejsu API do utworzenia (http, soap, websocket, graphql). Ten parametr jest opcjonalny.

Typ:Nullable<T>[PsApiManagementApiType]
Dopuszczalne wartości:Http, Soap, WebSocket, GraphQL
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AuthorizationScope

Określa zakres operacji OAuth. Wartość domyślna to $Null.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AuthorizationServerId

Określa identyfikator serwera autoryzacji OAuth. Wartość domyślna to $Null. Należy określić ten parametr, jeśli określono AuthorizationScope.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-BearerTokenSendingMethod

Mechanizm serwera autoryzacji OpenId, za pomocą którego token dostępu jest przekazywany do interfejsu API. Zapoznaj się z https://datatracker.ietf.org/doc/html/rfc6749#section-4. Ten parametr jest opcjonalny. Wartość domyślna to $null.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ContactEmail

Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ContactName

Nazwa identyfikująca osoby kontaktowej/organizacji. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ContactUrl

Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Context

Określa obiekt PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Description

Określa opis internetowego interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-InputObject

Wystąpienie psApiManagementApi. Ten parametr jest wymagany.

Typ:PsApiManagementApi
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-LicenseName

Nazwa licencji używana dla interfejsu API. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-LicenseUrl

Adres URL warunków użytkowania usługi dla interfejsu API. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwę internetowego interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-OpenIdProviderId

Identyfikator serwera autoryzacji OpenId. Ten parametr jest opcjonalny. Wartość domyślna to $null. Należy określić, jeśli określono element BearerTokenSendingMethods.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Path

Określa ścieżkę internetowego interfejsu API, która jest ostatnią częścią publicznego adresu URL interfejsu API. Ten adres URL jest używany przez użytkowników interfejsu API do wysyłania żądań do usługi internetowej i musi mieć długość od 400 znaków. Wartość domyślna to $Null.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Protocols

Określa tablicę protokołów internetowego interfejsu API. psdx_paramvalues http i https. Są to protokoły internetowe, za pośrednictwem których udostępniono interfejs API. Wartość domyślna to $Null.

Typ:PsApiManagementSchema[]
Dopuszczalne wartości:Http, Https, Ws, Wss
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ServiceUrl

Określa adres URL usługi internetowej, która uwidacznia interfejs API. Ten adres URL jest używany tylko przez usługę Azure API Management i nie jest upubliczniony. Adres URL musi mieć długość od 2000 znaków.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SubscriptionKeyHeaderName

Określa nazwę nagłówka klucza subskrypcji. Wartość domyślna to $Null.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SubscriptionKeyQueryParamName

Określa nazwę parametru ciągu zapytania klucza subskrypcji. Wartość domyślna to $Null.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SubscriptionRequired

Flaga wymuszania subskrypcjiWymagane dla żądań do interfejsu API. Ten parametr jest opcjonalny.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-TermsOfServiceUrl

Adres URL warunków użytkowania usługi dla interfejsu API. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

Dane wyjściowe