ApiWiki interface
ApiWiki を表すインターフェイス。
メソッド
| create |
API の新しい Wiki を作成するか、既存の Wiki を更新します。 |
| delete(string, string, string, string, Api |
指定した Wiki を API から削除します。 |
| get(string, string, string, Api |
識別子で指定された API の Wiki の詳細を取得します。 |
| get |
識別子で指定された API の Wiki のエンティティ状態 (Etag) バージョンを取得します。 |
| update(string, string, string, string, Wiki |
識別子で指定された API の Wiki の詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)
API の新しい Wiki を作成するか、既存の Wiki を更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- WikiContract
パラメーターを作成します。
options パラメーター。
戻り値
Promise<ApiWikiCreateOrUpdateResponse>
delete(string, string, string, string, ApiWikiDeleteOptionalParams)
指定した Wiki を API から削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ApiWikiDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ApiWikiGetOptionalParams)
識別子で指定された API の Wiki の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ApiWikiGetOptionalParams
options パラメーター。
戻り値
Promise<ApiWikiGetResponse>
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)
識別子で指定された API の Wiki のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ApiWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)
識別子で指定された API の Wiki の詳細を更新します。
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- WikiUpdateContract
Wiki Update パラメーター。
- options
- ApiWikiUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApiWikiUpdateResponse>