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 入口網站
選項參數。
傳回
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 入口網站
選項參數。
傳回
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
選項參數。
傳回
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
選項參數。
傳回
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
選項參數。
傳回
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
選項參數。
傳回
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
要驗證的自定義網域承載
選項參數。
傳回
Promise<CustomDomainValidateResult>