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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- 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
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
- serviceName
-
string
Имя ресурса службы.
- apiPortalName
-
string
Имя портала API.
- validatePayload
- CustomDomainValidatePayload
Полезные данные личного домена для проверки
Параметры параметров.
Возвращаемое значение
Promise<CustomDomainValidateResult>
