ApiPortals interface
表示 ApiPortals 的接口。
方法
方法详细信息
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>
