Set-AzApiManagementApi

モジュール:

Az.ApiManagement

API を変更します。

構文

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

説明

Set-AzApiManagementApi コマンドレットは、Azure API Management API を変更します。

例

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

例 2: 既存の ApiVersionSet に API を追加する

$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

この例では、既存の API バージョン セットに API を追加します

例 3: API が指しているバックエンド ServiceUrl を変更する

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

この例では、 echo-api が指している ServiceUrl を更新します。

パラメーター

-ApiId

変更する API の ID を指定します。

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

-ApiType

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

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

-AuthorizationScope

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

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

-AuthorizationServerId

OAuth 承認サーバー識別子を指定します。 既定値は $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

-InputObject

PsApiManagementApi のインスタンス。 このパラメーターは必須です。

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

-LicenseName

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

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

-LicenseUrl

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

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

-Name

Web API の名前を指定します。

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

-OpenIdProviderId

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

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

-PassThru

passthru

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

-Path

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

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

-Protocols

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

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

-ServiceUrl

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

型:	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

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

出力

PsApiManagementApi

関連リンク

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