ContentItem interface
ContentItem を表すインターフェイス。
メソッド
| create |
指定されたコンテンツ タイプで指定された新しい開発者ポータルのコンテンツ アイテムを作成します。 |
| delete(string, string, string, string, string, Content |
指定した開発者ポータルのコンテンツ アイテムを削除します。 |
| get(string, string, string, string, Content |
識別子で指定された開発者ポータルのコンテンツ アイテムを返します。 |
| get |
識別子で指定された開発者ポータルのコンテンツ アイテムのエンティティ状態 (ETag) バージョンを返します。 |
| list |
指定されたコンテンツ タイプで指定された開発者ポータルのコンテンツ アイテムを一覧表示します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, ContentItemContract, ContentItemCreateOrUpdateOptionalParams)
指定されたコンテンツ タイプで指定された新しい開発者ポータルのコンテンツ アイテムを作成します。
function createOrUpdate(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, parameters: ContentItemContract, options?: ContentItemCreateOrUpdateOptionalParams): Promise<ContentItemCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- contentItemId
-
string
コンテンツ アイテム識別子。
- parameters
- ContentItemContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<ContentItemCreateOrUpdateResponse>
delete(string, string, string, string, string, ContentItemDeleteOptionalParams)
指定した開発者ポータルのコンテンツ アイテムを削除します。
function delete(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, ifMatch: string, options?: ContentItemDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- contentItemId
-
string
コンテンツ アイテム識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ContentItemDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ContentItemGetOptionalParams)
識別子で指定された開発者ポータルのコンテンツ アイテムを返します。
function get(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, options?: ContentItemGetOptionalParams): Promise<ContentItemGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- contentItemId
-
string
コンテンツ アイテム識別子。
- options
- ContentItemGetOptionalParams
options パラメーター。
戻り値
Promise<ContentItemGetResponse>
getEntityTag(string, string, string, string, ContentItemGetEntityTagOptionalParams)
識別子で指定された開発者ポータルのコンテンツ アイテムのエンティティ状態 (ETag) バージョンを返します。
function getEntityTag(resourceGroupName: string, serviceName: string, contentTypeId: string, contentItemId: string, options?: ContentItemGetEntityTagOptionalParams): Promise<ContentItemGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- contentItemId
-
string
コンテンツ アイテム識別子。
options パラメーター。
戻り値
Promise<ContentItemGetEntityTagHeaders>
listByService(string, string, string, ContentItemListByServiceOptionalParams)
指定されたコンテンツ タイプで指定された開発者ポータルのコンテンツ アイテムを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, contentTypeId: string, options?: ContentItemListByServiceOptionalParams): PagedAsyncIterableIterator<ContentItemContract, ContentItemContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
options パラメーター。