ApiDefinitions interface
Interface que representa um ApiDefinitions.
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exporta a especificação da API.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exporta a especificação da API.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
Os parâmetros de opções.
Devoluções
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importa a especificação da API.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
- body
- ApiSpecImportRequest
O conteúdo do pedido de ação
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importa a especificação da API.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
- body
- ApiSpecImportRequest
O conteúdo do pedido de ação
Os parâmetros de opções.
Devoluções
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Cria uma nova definição de API ou atualiza a existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
- resource
- ApiDefinition
Parâmetros de criação de recursos.
Os parâmetros de opções.
Devoluções
Promise<ApiDefinitionsCreateOrUpdateResponse>
Exclui a definição de API especificada.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
Os parâmetros de opções.
Devoluções
Promise<void>
Retorna detalhes da definição da API.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
- options
- ApiDefinitionsGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiDefinitionsGetResponse>
Verifica se a definição de API especificada existe.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- definitionName
-
string
O nome da definição da API.
- options
- ApiDefinitionsHeadOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiDefinitionsHeadResponse>
Retorna uma coleção de definições de API.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Central de API do Azure.
- workspaceName
-
string
O nome do espaço de trabalho.
- apiName
-
string
O nome da API.
- versionName
-
string
O nome da versão da API.
- options
- ApiDefinitionsListOptionalParams
Os parâmetros de opções.