ApiPortals interface
Interfaz que representa apiPortals.
Métodos
| begin |
Cree el portal de API predeterminado o actualice el portal de API existente. |
| begin |
Cree el portal de API predeterminado o actualice el portal de API existente. |
| begin |
Elimine el portal de API predeterminado. |
| begin |
Elimine el portal de API predeterminado. |
| get(string, string, string, Api |
Obtenga el portal de API y sus propiedades. |
| list(string, string, Api |
Controla las solicitudes para enumerar todos los recursos de un servicio. |
| validate |
Compruebe que los dominios son válidos, así como no están en uso. |
Detalles del método
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Cree el portal de API predeterminado o actualice el portal de API existente.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- apiPortalResource
- ApiPortalResource
Portal de API para la operación de creación o actualización
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Cree el portal de API predeterminado o actualice el portal de API existente.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- apiPortalResource
- ApiPortalResource
Portal de API para la operación de creación o actualización
Parámetros de opciones.
Devoluciones
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Elimine el portal de API predeterminado.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- options
- ApiPortalsDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Elimine el portal de API predeterminado.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- options
- ApiPortalsDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Obtenga el portal de API y sus propiedades.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- options
- ApiPortalsGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Controla las solicitudes para enumerar todos los recursos de un servicio.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- options
- ApiPortalsListOptionalParams
Parámetros de opciones.
Devoluciones
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Compruebe que los dominios son válidos, así como no están en uso.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
- serviceName
-
string
Nombre del recurso De servicio.
- apiPortalName
-
string
Nombre del portal de API.
- validatePayload
- CustomDomainValidatePayload
Carga de dominio personalizada que se va a validar
Parámetros de opciones.
Devoluciones
Promise<CustomDomainValidateResult>