New-AzApiManagementApi
Membuat API.
Sintaks
New-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>]
[-ProductIds <String[]>]
[-SubscriptionRequired]
[-ApiVersionDescription <String>]
[-ApiVersionSetId <String>]
[-ApiVersion <String>]
[-SourceApiId <String>]
[-SourceApiRevision <String>]
[-ApiType <PsApiManagementApiType>]
[-TermsOfServiceUrl <String>]
[-ContactName <String>]
[-ContactUrl <String>]
[-ContactEmail <String>]
[-LicenseName <String>]
[-LicenseUrl <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Deskripsi
Cmdlet New-AzApiManagementApi membuat API Api Management Azure.
Contoh
Contoh 1: Membuat API
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"
Perintah ini membuat API bernama EchoApi dengan URL yang ditentukan.
Contoh 2: Buat API dengan menyalin semua operasi, Tag, Produk, dan Kebijakan dari echo-api dan ke dalam ApiVersionSet
$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"
ApiId : 691b7d410125414a929c108541c60e06
Name : echoapiv4
Description : Create Echo Api V4
ServiceUrl : https://echoapi.cloudapp.net/v4
Path : echov3
ApiType : http
Protocols : {Http, Https}
AuthorizationServerId :
AuthorizationScope :
OpenidProviderId :
BearerTokenSendingMethod : {}
SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision : 1
ApiVersion : v4
IsCurrent : True
IsOnline : False
SubscriptionRequired : True
ApiRevisionDescription :
ApiVersionSetDescription :
ApiVersionSetId : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName : Api-Default-West-US
ServiceName : contoso
Perintah ini membuat API echoapiv3
di ApiVersionSet xmsVersionSet
dan menyalin semua operasi, Tag dan Kebijakan dari Api echo-api
sumber . Ini mengambil alih SubscriptionRequired, ServiceUrl, Path, Protocols
Contoh 3
Membuat API. (dibuat otomatis)
New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'
Parameter
-ApiId
Menentukan ID API yang akan dibuat. Jika Anda tidak menentukan parameter ini, cmdlet ini akan menghasilkan ID untuk Anda.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiType
Jenis API yang akan dibuat (http, soap, websocket, graphql). Parameter ini bersifat opsional.
Jenis: | Nullable<T>[PsApiManagementApiType] |
nilai yang diterima: | Http, Soap, WebSocket, GraphQL |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersion
Api Versi Api yang akan dibuat. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionDescription
Deskripsi Versi Api. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionSetId
Pengidentifikasi sumber daya untuk Set Versi Api terkait. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationScope
Menentukan cakupan operasi OAuth. Nilai defaultnya adalah $Null.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationServerId
Menentukan ID server otorisasi OAuth. Nilai defaultnya adalah $Null. Anda harus menentukan parameter ini jika AuthorizationScope ditentukan.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | 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.
Jenis: | String[] |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactEmail
Alamat email orang/organisasi kontak. HARUS dalam format alamat email. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactName
Nama pengidentifikasi orang/organisasi kontak. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactUrl
URL yang menunjuk ke informasi kontak. HARUS dalam format URL. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Context
Menentukan objek PsApiManagementContext.
Jenis: | PsApiManagementContext |
Position: | Named |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure.
Jenis: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Menentukan deskripsi untuk API web.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseName
Nama lisensi yang digunakan untuk API. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseUrl
URL ke Ketentuan Layanan untuk API. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Menentukan nama API web. Ini adalah nama publik API seperti yang muncul di portal pengembang dan admin.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OpenIdProviderId
Pengidentifikasi server otorisasi OpenId. Parameter ini bersifat opsional. Nilai defaultnya adalah $null. Harus ditentukan jika BearerTokenSendingMethods ditentukan.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Menentukan jalur API web, yang merupakan bagian terakhir dari URL publik API dan sesuai dengan bidang akhiran URL API Web di portal admin. URL ini digunakan oleh konsumen API untuk mengirim permintaan ke layanan web, dan panjangnya harus satu hingga 400 karakter. Nilai defaultnya adalah $Null.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductIds
Menentukan array ID produk untuk menambahkan API baru.
Jenis: | String[] |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Protocols
Menentukan array protokol API web. Nilai yang valid adalah http, https. Ini adalah protokol web tempat API tersedia. Nilai defaultnya adalah $Null.
Jenis: | PsApiManagementSchema[] |
nilai yang diterima: | Http, Https, Ws, Wss |
Position: | Named |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | 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.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiId
Pengidentifikasi api dari API sumber. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiRevision
Revisi Api dari API sumber. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Menentukan nama header kunci langganan. Nilai defaultnya adalah $Null.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
Menentukan nama parameter string kueri kunci langganan. Nilai defaultnya adalah $Null.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionRequired
Bendera untuk memberlakukan SubscriptionRequired untuk permintaan ke Api. Parameter ini bersifat opsional.
Jenis: | SwitchParameter |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TermsOfServiceUrl
URL ke Ketentuan Layanan untuk API. Parameter ini bersifat opsional.
Jenis: | String |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Input
String[]
Output
Link Terkait
Azure PowerShell
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk