ApiPortals interface
Interface que representa um ApiPortals.
Métodos
| begin |
Crie o portal de API padrão ou atualize o portal de API existente. |
| begin |
Crie o portal de API padrão ou atualize o portal de API existente. |
| begin |
Exclua o portal de API padrão. |
| begin |
Exclua o portal de API padrão. |
| get(string, string, string, Api |
Obtenha o portal de API e suas propriedades. |
| list(string, string, Api |
Manipula solicitações para listar todos os recursos em um Serviço. |
| validate |
Verifique se os domínios são válidos, bem como não estão em uso. |
Detalhes do método
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Crie o portal de API padrão ou atualize o 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
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- apiPortalResource
- ApiPortalResource
O portal de API para a operação de criação ou atualização
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Crie o portal de API padrão ou atualize o portal de API existente.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- apiPortalResource
- ApiPortalResource
O portal de API para a operação de criação ou atualização
Os parâmetros de opções.
Retornos
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Exclua o portal de API padrão.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- options
- ApiPortalsDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Exclua o portal de API padrão.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- options
- ApiPortalsDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Obtenha o portal de API e suas propriedades.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- options
- ApiPortalsGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Manipula solicitações para listar todos os recursos em um Serviço.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- options
- ApiPortalsListOptionalParams
Os parâmetros de opções.
Retornos
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Verifique se os domínios são válidos, bem como não estão em uso.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
- serviceName
-
string
O nome do recurso serviço.
- apiPortalName
-
string
O nome do portal de API.
- validatePayload
- CustomDomainValidatePayload
Conteúdo de domínio personalizado a ser validado
Os parâmetros de opções.
Retornos
Promise<CustomDomainValidateResult>