PortalConfig interface
PortalConfig を表すインターフェイス。
メソッド
| create |
開発者ポータルの構成を作成または更新します。 |
| get(string, string, string, Portal |
開発者ポータルの構成を取得します。 |
| get |
開発者ポータル構成のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
開発者ポータルの構成を一覧表示します。 |
| update(string, string, string, string, Portal |
開発者ポータルの構成を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, PortalConfigContract, PortalConfigCreateOrUpdateOptionalParams)
開発者ポータルの構成を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigCreateOrUpdateOptionalParams): Promise<PortalConfigContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- portalConfigId
-
string
ポータル構成識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- PortalConfigContract
開発者ポータルの構成を更新します。
options パラメーター。
戻り値
Promise<PortalConfigContract>
get(string, string, string, PortalConfigGetOptionalParams)
開発者ポータルの構成を取得します。
function get(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetOptionalParams): Promise<PortalConfigGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- portalConfigId
-
string
ポータル構成識別子。
- options
- PortalConfigGetOptionalParams
options パラメーター。
戻り値
Promise<PortalConfigGetResponse>
getEntityTag(string, string, string, PortalConfigGetEntityTagOptionalParams)
開発者ポータル構成のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetEntityTagOptionalParams): Promise<PortalConfigGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- portalConfigId
-
string
ポータル構成識別子。
options パラメーター。
戻り値
Promise<PortalConfigGetEntityTagHeaders>
listByService(string, string, PortalConfigListByServiceOptionalParams)
開発者ポータルの構成を一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: PortalConfigListByServiceOptionalParams): Promise<PortalConfigCollection>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<PortalConfigCollection>
update(string, string, string, string, PortalConfigContract, PortalConfigUpdateOptionalParams)
開発者ポータルの構成を更新します。
function update(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigUpdateOptionalParams): Promise<PortalConfigContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- portalConfigId
-
string
ポータル構成識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- PortalConfigContract
開発者ポータルの構成を更新します。
- options
- PortalConfigUpdateOptionalParams
options パラメーター。
戻り値
Promise<PortalConfigContract>