ContentType interface
ContentType を表すインターフェイス。
メソッド
| create |
開発者ポータルのコンテンツ タイプを作成または更新します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 カスタム コンテンツ タイプの識別子はプレフィックスで |
| delete(string, string, string, string, Content |
指定した開発者ポータルのコンテンツ タイプを削除します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 組み込みのコンテンツ タイプ (プレフィックスで始まる識別子を |
| get(string, string, string, Content |
開発者ポータルのコンテンツ タイプの詳細を取得します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 |
| list |
開発者ポータルのコンテンツ タイプを一覧表示します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 |
メソッドの詳細
createOrUpdate(string, string, string, ContentTypeContract, ContentTypeCreateOrUpdateOptionalParams)
開発者ポータルのコンテンツ タイプを作成または更新します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 カスタム コンテンツ タイプの識別子はプレフィックスで c- 始まる必要があります。 組み込みのコンテンツ タイプは変更できません。
function createOrUpdate(resourceGroupName: string, serviceName: string, contentTypeId: string, parameters: ContentTypeContract, options?: ContentTypeCreateOrUpdateOptionalParams): Promise<ContentTypeCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- parameters
- ContentTypeContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<ContentTypeCreateOrUpdateResponse>
delete(string, string, string, string, ContentTypeDeleteOptionalParams)
指定した開発者ポータルのコンテンツ タイプを削除します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。 組み込みのコンテンツ タイプ (プレフィックスで始まる識別子を c- 含む) は削除できません。
function delete(resourceGroupName: string, serviceName: string, contentTypeId: string, ifMatch: string, options?: ContentTypeDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ContentTypeDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ContentTypeGetOptionalParams)
開発者ポータルのコンテンツ タイプの詳細を取得します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。
function get(resourceGroupName: string, serviceName: string, contentTypeId: string, options?: ContentTypeGetOptionalParams): Promise<ContentTypeGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- contentTypeId
-
string
コンテンツ タイプ識別子。
- options
- ContentTypeGetOptionalParams
options パラメーター。
戻り値
Promise<ContentTypeGetResponse>
listByService(string, string, ContentTypeListByServiceOptionalParams)
開発者ポータルのコンテンツ タイプを一覧表示します。 コンテンツ タイプは、コンテンツ アイテムのプロパティ、検証ルール、制約を記述します。
function listByService(resourceGroupName: string, serviceName: string, options?: ContentTypeListByServiceOptionalParams): PagedAsyncIterableIterator<ContentTypeContract, ContentTypeContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。