New-AzApiManagementApi

  • Başvuru
Modül:
Az.ApiManagement

Bir API oluşturur.

Sözdizimi

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

Description

New-AzApiManagementApi cmdlet'i bir Azure API Management API'si oluşturur.

Örnekler

Örnek 1: API oluşturma

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

Bu komut, belirtilen URL ile EchoApi adlı bir API oluşturur.

Örnek 2: Echo-API'den ve ApiVersionSet'e tüm işlemleri, Etiketleri, Ürünleri ve İlkeleri kopyalayarak API oluşturma

$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

Bu komut ApiVersionSet'te xmsVersionSet bir API echoapiv3 oluşturur ve kaynak Api'den echo-apitüm işlemleri, Etiketleri ve İlkeleri kopyalar. SubscriptionRequired, ServiceUrl, Path, Protocols geçersiz kılar

Örnek 3

Bir API oluşturur. (otomatik olarak oluşturulmuş)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

Parametreler

-ApiId

Oluşturulacak API'nin kimliğini belirtir. Bu parametreyi belirtmezseniz, bu cmdlet sizin için bir kimlik oluşturur.

Tür:String
Position:Named
Default value:None
Gerekli:False
İş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

-ApiVersion

Oluşturulacak Api'nin Api Sürümü. 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

-ApiVersionDescription

Api Sürüm Açıklaması. 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

-ApiVersionSetId

İlgili Api Sürüm Kümesi için bir kaynak tanımlayıcısı. 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

-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 kimliğini 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

-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. Bu, api'nin geliştirici ve yönetici portallarında göründüğü genel adıdır.

Tür:String
Position:Named
Default value:None
Gerekli:True
İş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

-Path

API'nin genel URL'sinin son bölümü olan ve yönetici portalındaki Web API'si URL'si soneki alanına karşılık gelen 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:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ProductIds

Yeni API'nin ekleneceği ürün kimlikleri dizisini belirtir.

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. Geçerli değerler http, https'dir. 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:True
İş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:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SourceApiId

Kaynak API'nin API tanımlayıcısı. 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

-SourceApiRevision

Kaynak API'nin Api Düzeltmesi. 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

-SubscriptionKeyHeaderName

Abonelik anahtarı üst bilgi 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 parametre 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

PsApiManagementSchema[]

String[]

Çıkışlar

PsApiManagementApi