ApiPortals interface
Interface que representa um ApiPortals.
Métodos
| begin |
Crie o portal de API predefinido ou atualize o portal de API existente. |
| begin |
Crie o portal de API predefinido ou atualize o portal de API existente. |
| begin |
Elimine o portal de API predefinido. |
| begin |
Elimine o portal de API predefinido. |
| get(string, string, string, Api |
Obtenha o portal da API e as respetivas propriedades. |
| list(string, string, Api |
Processa pedidos para listar todos os recursos num Serviço. |
| validate |
Verifique se os domínios são válidos e não estão a ser utilizados. |
Detalhes de Método
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Crie o portal de API predefinido 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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- apiPortalResource
- ApiPortalResource
O portal da API para a operação de criação ou atualização
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Crie o portal de API predefinido 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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- apiPortalResource
- ApiPortalResource
O portal da API para a operação de criação ou atualização
Os parâmetros de opções.
Devoluções
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Elimine o portal de API predefinido.
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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- options
- ApiPortalsDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Elimine o portal de API predefinido.
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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- options
- ApiPortalsDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Obtenha o portal da API e as respetivas 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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- options
- ApiPortalsGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Processa pedidos para listar todos os recursos num 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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- options
- ApiPortalsListOptionalParams
Os parâmetros de opções.
Devoluções
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Verifique se os domínios são válidos e não estão a ser utilizados.
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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
- serviceName
-
string
O nome do recurso do Serviço.
- apiPortalName
-
string
O nome do portal da API.
- validatePayload
- CustomDomainValidatePayload
Payload de domínio personalizado a validar
Os parâmetros de opções.
Devoluções
Promise<CustomDomainValidateResult>