Apis - Update

API 管理サービス インスタンスの指定された API を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2019-12-01

URI パラメーター

Name In Required Type Description
apiId
path True
  • string

API リビジョン識別子。 現在の API 管理サービス インスタンス内で一意である必要があります。 現在以外のリビジョンの場合、リビジョン番号を n にするサフィックスとして、;rev=n が付いています。

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

リソース グループの名前。

serviceName
path True
  • string

API 管理サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

要求ヘッダー

Name Required Type Description
If-Match True
  • string

エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致する必要があります。

要求本文

Name Type Description
properties.apiRevision
  • string

API のリビジョンについて説明します。 値が指定されていない場合、デフォルトのリビジョン 1 が作成されます。

properties.apiRevisionDescription
  • string

API リビジョンの説明。

properties.apiVersion
  • string

API がバージョン対応の場合、API のバージョン識別子を示します。

properties.apiVersionDescription
  • string

API バージョンの説明。

properties.apiVersionSetId
  • string

関連する ApiVersionSet のリソース識別子。

properties.authenticationSettings

この API に含まれる認証設定のコレクション。

properties.description
  • string

API の説明。 HTML 書式設定タグを含めることができます。

properties.displayName
  • string

API 名。

properties.isCurrent
  • boolean

API リビジョンが現在の API リビジョンであるかどうかを示します。

properties.path
  • string

API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。

properties.protocols
  • string[]

この API の操作を呼び出すことができるプロトコルを記述します。

properties.serviceUrl
  • string

この API を実装するバックエンド サービスの絶対 URL。

properties.subscriptionKeyParameterNames

API が使用可能になるプロトコル。

properties.subscriptionRequired
  • boolean

API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。

properties.type

API の種類。

応答

Name Type Description
204 No Content

API は正常に更新されました。

Other Status Codes

操作が失敗した理由を示すエラー応答です。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementUpdateApi

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api?api-version=2019-12-01
If-Match: *
{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Sample Response

定義

ApiType

API の種類。

ApiUpdateContract

API 更新コントラクトの詳細。

AuthenticationSettingsContract

API 認証設定。

ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

ApiType

API の種類。

Name Type Description
http
  • string
soap
  • string

ApiUpdateContract

API 更新コントラクトの詳細。

Name Type Description
properties.apiRevision
  • string

API のリビジョンについて説明します。 値が指定されていない場合、デフォルトのリビジョン 1 が作成されます。

properties.apiRevisionDescription
  • string

API リビジョンの説明。

properties.apiVersion
  • string

API がバージョン対応の場合、API のバージョン識別子を示します。

properties.apiVersionDescription
  • string

API バージョンの説明。

properties.apiVersionSetId
  • string

関連する ApiVersionSet のリソース識別子。

properties.authenticationSettings

この API に含まれる認証設定のコレクション。

properties.description
  • string

API の説明。 HTML 書式設定タグを含めることができます。

properties.displayName
  • string

API 名。

properties.isCurrent
  • boolean

API リビジョンが現在の API リビジョンであるかどうかを示します。

properties.isOnline
  • boolean

ゲートウェイ経由で API リビジョンにアクセスできるかどうかを示します。

properties.path
  • string

API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。

properties.protocols
  • string[]

この API の操作を呼び出すことができるプロトコルを記述します。

properties.serviceUrl
  • string

この API を実装するバックエンド サービスの絶対 URL。

properties.subscriptionKeyParameterNames

API が使用可能になるプロトコル。

properties.subscriptionRequired
  • boolean

API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。

properties.type

API の種類。

AuthenticationSettingsContract

API 認証設定。

Name Type Description
oAuth2

OAuth2 認証設定

openid

OpenID 接続認証設定

ErrorFieldContract

エラー フィールド コントラクト。

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に、要求で送信される無効なフィールドのリスト。

error.message
  • string

エラーの人間が読み取り可能な表現。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

Name Type Description
authorizationServerId
  • string

OAuth 承認サーバーの識別子。

scope
  • string

操作のスコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

Name Type Description
bearerTokenSendingMethods
  • string[]

サーバーにトークンを送信する方法。

openidProviderId
  • string

OAuth 承認サーバーの識別子。

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

Name Type Description
header
  • string

サブスクリプション キー ヘッダー名。

query
  • string

サブスクリプション キーのクエリ文字列パラメーター名。