Set-AzApiManagementApi

  • Başvuru
Modül:
Az.ApiManagement

API'yi değiştirir.

Sözdizimi

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

Set-AzApiManagementApi cmdlet'i bir Azure API Management API'sini değiştirir.

Örnekler

Örnek 1: API'yi değiştirme

$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"

Örnek 2: Var olan bir ApiVersionSet'e API ekleme

$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

Bu örnek, var olan bir API Sürüm Kümesine API ekler

Örnek 3: API'nin işaret ettiği Arka Uç ServiceUrl değerini değiştirme

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

Bu örnek, işaret eden ServiceUrl'i echo-api güncelleştirir.

Parametreler

-ApiId

Değiştirileceği API'nin kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ApiType

Oluşturulacak API türü (http, soap, websocket, graphql). Bu parametre isteğe bağlıdır.

Tür:Nullable<T>[PsApiManagementApiType]
Kabul edilen değerler:Http, Soap, WebSocket, GraphQL
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-AuthorizationScope

OAuth işlemleri kapsamını belirtir. Varsayılan değer $Null.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-AuthorizationServerId

OAuth yetkilendirme sunucusu tanımlayıcısını belirtir. Varsayılan değer $Null. AuthorizationScope belirtilirse bu parametreyi belirtmeniz gerekir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-BearerTokenSendingMethod

Erişim belirtecinin API'ye geçirildiği OpenId yetkilendirme sunucusu mekanizması. öğesine https://datatracker.ietf.org/doc/html/rfc6749#section-4bakın. Bu parametre isteğe bağlıdır. Varsayılan değer $null.

Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ContactEmail

İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ContactName

İlgili kişinin/kuruluşun tanımlayıcı adı. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ContactUrl

kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Context

PsApiManagementContext nesnesini belirtir.

Tür:PsApiManagementContext
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Description

Web API'sinin açıklamasını belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-InputObject

PsApiManagementApi örneği. Bu parametre zorunludur.

Tür:PsApiManagementApi
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-LicenseName

API için kullanılan lisans adı. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-LicenseUrl

API için Hizmet Koşulları'nın URL'si. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Name

Web API'sinin adını belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-OpenIdProviderId

OpenId yetkilendirme sunucusu tanımlayıcısı. Bu parametre isteğe bağlıdır. Varsayılan değer $null. BearerTokenSendingMethods belirtildiyse belirtilmelidir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PassThru

geçiş

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Path

API'nin genel URL'sinin son bölümü olan web API'si yolunu belirtir. Bu URL, API tüketicileri tarafından web hizmetine istek göndermek için kullanılır ve bir ile 400 karakter uzunluğunda olmalıdır. Varsayılan değer $Null.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Protocols

Bir web API protokolleri dizisi belirtir. http ve https psdx_paramvalues. Bunlar, API'nin kullanıma sunulduğu web protokolleridir. Varsayılan değer $Null.

Tür:PsApiManagementSchema[]
Kabul edilen değerler:Http, Https, Ws, Wss
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ServiceUrl

API'yi kullanıma sunan web hizmetinin URL'sini belirtir. Bu URL yalnızca Azure API Management tarafından kullanılır ve genel kullanıma açık değildir. URL bir ile 2000 karakter uzunluğunda olmalıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SubscriptionKeyHeaderName

Abonelik anahtarı üst bilgisinin adını belirtir. Varsayılan değer $Null.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SubscriptionKeyQueryParamName

Abonelik anahtarı sorgu dizesi parametresinin adını belirtir. Varsayılan değer $Null.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SubscriptionRequired

Api'ye yönelik istekler için SubscriptionRequired'ı zorunlu kılma bayrağı. Bu parametre isteğe bağlıdır.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-TermsOfServiceUrl

API için Hizmet Koşulları'nın URL'si. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

Girişler

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Çıkışlar

PsApiManagementApi