ApiPortals interface
ApiPortals を表すインターフェイス。
メソッド
| begin |
既定の API ポータルを作成するか、既存の API ポータルを更新します。 |
| begin |
既定の API ポータルを作成するか、既存の API ポータルを更新します。 |
| begin |
既定の API ポータルを削除します。 |
| begin |
既定の API ポータルを削除します。 |
| get(string, string, string, Api |
API ポータルとそのプロパティを取得します。 |
| list(string, string, Api |
サービス内のすべてのリソースを一覧表示する要求を処理します。 |
| validate |
ドメインが有効であり、使用されていないことを確認します。 |
メソッドの詳細
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
既定の API ポータルを作成するか、既存の API ポータルを更新します。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- apiPortalResource
- ApiPortalResource
作成または更新操作の API ポータル
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
既定の API ポータルを作成するか、既存の API ポータルを更新します。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- apiPortalResource
- ApiPortalResource
作成または更新操作の API ポータル
options パラメーター。
戻り値
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
既定の API ポータルを削除します。
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- options
- ApiPortalsDeleteOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
既定の API ポータルを削除します。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- options
- ApiPortalsDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
API ポータルとそのプロパティを取得します。
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- options
- ApiPortalsGetOptionalParams
options パラメーター。
戻り値
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
サービス内のすべてのリソースを一覧表示する要求を処理します。
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- options
- ApiPortalsListOptionalParams
options パラメーター。
戻り値
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
ドメインが有効であり、使用されていないことを確認します。
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>パラメーター
- resourceGroupName
-
string
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- apiPortalName
-
string
API ポータルの名前。
- validatePayload
- CustomDomainValidatePayload
検証するカスタム ドメイン ペイロード
options パラメーター。
戻り値
Promise<CustomDomainValidateResult>