New-AzApiManagementApi

リファレンス

モジュール:: Az.ApiManagement

API を作成します。

構文

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

説明

New-AzApiManagementApi コマンドレットは、Azure API Management API を作成します。

例

例 1: 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"

このコマンドは、指定された URL を使用して EchoApi という名前の API を作成します。

例 2: echo-api から ApiVersionSet にすべての操作、タグ、製品、およびポリシーをコピーして API を作成する

$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

このコマンドは、ApiVersionSet xmsVersionSetで API echoapiv3を作成し、ソース Api echo-apiからすべての操作、タグ、ポリシーをコピーします。 SubscriptionRequired、ServiceUrl、Path、Protocols をオーバーライドします

例 3

API を作成します。 (自動生成)

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

パラメーター

-ApiId

作成する API の ID を指定します。このパラメーターを指定しない場合、このコマンドレットによって ID が生成されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ApiType

作成する API の種類 (http、soap、websocket、graphql)。このパラメーターは省略可能です。

型:	Nullable<T>[PsApiManagementApiType]
指定可能な値:	Http, Soap, WebSocket, GraphQL
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ApiVersion

作成する API のバージョン。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ApiVersionDescription

API バージョンの説明。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ApiVersionSetId

関連する API バージョンセットのリソース識別子。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-AuthorizationScope

OAuth 操作スコープを指定します。既定値は $Null です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-AuthorizationServerId

OAuth 承認サーバー ID を指定します。既定値は $Null です。 AuthorizationScope を指定する場合は、このパラメーターを指定する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-BearerTokenSendingMethod

アクセストークンが API に渡される OpenId 承認サーバーメカニズム。 [https://aka.ms/classiciaasmigrationfaqs](https://datatracker.ietf.org/doc/html/rfc6749#section-4 ) を参照してください。このパラメーターは省略可能です。既定値は $null です。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ContactEmail

連絡先の個人/組織の電子メールアドレス。メールアドレスの形式にする必要があります。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ContactName

連絡先の個人/組織の識別名。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ContactUrl

連絡先情報を指す URL。 URL の形式にする必要があります。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Context

PsApiManagementContext オブジェクトを指定します。

型:	PsApiManagementContext
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Description

Web API の説明を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LicenseName

API に使用されるライセンス名。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LicenseUrl

API のサービス利用規約への URL。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

Web API の名前を指定します。これは、開発者ポータルと管理ポータルに表示される API のパブリック名です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-OpenIdProviderId

OpenId 承認サーバー識別子。このパラメーターは省略可能です。既定値は $null です。 BearerTokenSendingMethods が指定されている場合は、指定する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Path

WEB API パスを指定します。これは API のパブリック URL の最後の部分であり、管理ポータルの Web API URL サフィックスフィールドに対応します。この URL は、WEB サービスに要求を送信するために API コンシューマーによって使用され、1 から 400 文字の長さにする必要があります。既定値は $Null です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ProductIds

新しい API を追加する製品 ID の配列を指定します。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Protocols

Web API プロトコルの配列を指定します。有効な値は http、https です。これらは、API を使用できるようにする Web プロトコルです。既定値は $Null です。

型:	PsApiManagementSchema[]
指定可能な値:	Http, Https, Ws, Wss
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ServiceUrl

API を公開する Web サービスの URL を指定します。この URL は Azure API Management でのみ使用され、公開されません。 URL の長さは 1 ~ 2,000 文字にする必要があります。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SourceApiId

ソース API の API 識別子。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SourceApiRevision

ソース API の API リビジョン。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SubscriptionKeyHeaderName

サブスクリプションキーのヘッダー名を指定します。既定値は $Null です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SubscriptionKeyQueryParamName

サブスクリプションキークエリ文字列パラメーター名を指定します。既定値は $Null です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SubscriptionRequired

Api への要求に SubscriptionRequired を適用するフラグ。このパラメーターは省略可能です。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-TermsOfServiceUrl

API のサービス利用規約への URL。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

出力

PsApiManagementApi

次の方法で共有

New-AzApiManagementApi

構文

説明

例

例 1: API を作成する

例 2: echo-api から ApiVersionSet にすべての操作、タグ、製品、およびポリシーをコピーして API を作成する

例 3

パラメーター

-ApiId

-ApiType

-ApiVersion

-ApiVersionDescription

-ApiVersionSetId

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-Path

-ProductIds

-Protocols

-ServiceUrl

-SourceApiId

-SourceApiRevision

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

入力

出力

その他のリソース

次の方法で共有

New-AzApiManagementApi

構文

説明

例

例 1: API を作成する

例 2: echo-api から ApiVersionSet にすべての操作、タグ、製品、およびポリシーをコピーして API を作成する

例 3

パラメーター

-ApiId

-ApiType

-ApiVersion

-ApiVersionDescription

-ApiVersionSetId

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-Path

-ProductIds

-Protocols

-ServiceUrl

-SourceApiId

-SourceApiRevision

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

入力

出力

関連リンク

その他のリソース