Documentation interface
ドキュメントを表すインターフェイス。
メソッド
| create |
新しいドキュメントを作成するか、既存のドキュメントを更新します。 |
| delete(string, string, string, string, Documentation |
指定したドキュメントを API から削除します。 |
| get(string, string, string, Documentation |
識別子で指定されたドキュメントの詳細を取得します。 |
| get |
ドキュメントのエンティティ状態 (Etag) バージョンを識別子で取得します。 |
| list |
API Management サービス インスタンスのすべてのドキュメントを一覧表示します。 |
| update(string, string, string, string, Documentation |
識別子で指定された API のドキュメントの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
新しいドキュメントを作成するか、既存のドキュメントを更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- documentationId
-
string
ドキュメント識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- DocumentationContract
パラメーターを作成します。
options パラメーター。
戻り値
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
指定したドキュメントを API から削除します。
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- documentationId
-
string
ドキュメント識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
識別子で指定されたドキュメントの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- documentationId
-
string
ドキュメント識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- DocumentationGetOptionalParams
options パラメーター。
戻り値
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
ドキュメントのエンティティ状態 (Etag) バージョンを識別子で取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- documentationId
-
string
ドキュメント識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
API Management サービス インスタンスのすべてのドキュメントを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
識別子で指定された API のドキュメントの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- documentationId
-
string
ドキュメント識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- DocumentationUpdateContract
ドキュメント更新パラメーター。
options パラメーター。
戻り値
Promise<DocumentationUpdateResponse>