Set-AzApiManagementApi

Modul:

Az.ApiManagement Module

Memodifikasi API.

Sintaks

ExpandedParameter (Default)

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

Deskripsi

Cmdlet Set-AzApiManagementApi memodifikasi API Azure API Management.

Contoh

Contoh 1: Mengubah 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"

Contoh 2: Menambahkan API ke ApiVersionSet yang ada

$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

Contoh ini menambahkan API ke Set Versi API yang ada

Contoh 3: Ubah Backend ServiceUrl tempat API menunjuk ke

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

Contoh ini memperbarui ServiceUrl yang echo-api diarahkan.

Parameter

-ApiId

Menentukan ID API yang akan diubah.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ExpandedParameter

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ApiType

Jenis API yang akan dibuat (http, soap, websocket, graphql). Parameter ini bersifat opsional.

Properti parameter

Jenis:	Nullable<T>[PsApiManagementApiType]
Nilai default:	None
Nilai yang diterima:	Http, Soap, WebSocket, GraphQL
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-AuthorizationScope

Menentukan cakupan operasi OAuth. Nilai defaultnya adalah $Null.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-AuthorizationServerId

Menentukan pengidentifikasi server otorisasi OAuth. Nilai defaultnya adalah $Null. Anda harus menentukan parameter ini jika AuthorizationScope ditentukan.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-BearerTokenSendingMethod

Mekanisme server otorisasi OpenId tempat token akses diteruskan ke API. Lihat https://datatracker.ietf.org/doc/html/rfc6749#section-4. Parameter ini bersifat opsional. Nilai defaultnya adalah $null.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ContactEmail

Alamat email orang/organisasi kontak. HARUS dalam format alamat email. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ContactName

Nama pengidentifikasi orang/organisasi kontak. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ContactUrl

URL yang menunjuk ke informasi kontak. HARUS dalam format URL. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Context

Menentukan objek PsApiManagementContext .

Properti parameter

Jenis:	PsApiManagementContext
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ExpandedParameter

Position:	Named
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure.

Properti parameter

Jenis:	IAzureContextContainer
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Description

Menentukan deskripsi untuk API web.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-InputObject

Instans PsApiManagementApi. Parameter ini diperlukan.

Properti parameter

Jenis:	PsApiManagementApi
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ByInputObject

Position:	Named
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-LicenseName

Nama lisensi yang digunakan untuk API. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-LicenseUrl

URL ke Ketentuan Layanan untuk API. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Name

Menentukan nama API web.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-OpenIdProviderId

Pengidentifikasi server otorisasi OpenId. Parameter ini bersifat opsional. Nilai defaultnya adalah $null. Harus ditentukan jika BearerTokenSendingMethods ditentukan.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-PassThru

passthru

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Path

Menentukan jalur API web, yang merupakan bagian terakhir dari URL publik API. URL ini digunakan oleh konsumen API untuk mengirim permintaan ke layanan web, dan panjangnya harus satu hingga 400 karakter. Nilai defaultnya adalah $Null.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Protocols

Menentukan array protokol API web. psdx_paramvalues http dan https. Ini adalah protokol web tempat API tersedia. Nilai defaultnya adalah $Null.

Properti parameter

Jenis:	PsApiManagementSchema[]
Nilai default:	None
Nilai yang diterima:	Http, Https, Ws, Wss
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ServiceUrl

Menentukan URL layanan web yang mengekspos API. URL ini hanya digunakan oleh Azure API Management, dan tidak dibuat publik. PANJANG URL harus satu hingga 2000 karakter.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-SubscriptionKeyHeaderName

Menentukan nama header kunci langganan. Nilai defaultnya adalah $Null.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-SubscriptionKeyQueryParamName

Menentukan nama parameter string kueri kunci langganan. Nilai defaultnya adalah $Null.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-SubscriptionRequired

Bendera untuk memberlakukan SubscriptionRequired untuk permintaan ke Api. Parameter ini bersifat opsional.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-TermsOfServiceUrl

URL ke Ketentuan Layanan untuk API. Parameter ini bersifat opsional.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema

SwitchParameter

Output

PsApiManagementApi

Link Terkait

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