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