Share via

ApiDefinitions interface

  • Reference
Package:
@azure/arm-apicenter

Interface representing a ApiDefinitions.

Methods

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exports the API specification.
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exports the API specification.
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Imports the API specification.
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Imports the API specification.
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

Creates new or updates existing API definition.
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

Deletes specified API definition.
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

Returns details of the API definition.
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

Checks if specified API definition exists.
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

Returns a collection of API definitions.

Method Details

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exports the API specification.

function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

options
ApiDefinitionsExportSpecificationOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exports the API specification.

function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

options
ApiDefinitionsExportSpecificationOptionalParams

The options parameters.

Returns

Promise<ApiSpecExportResult>

beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Imports the API specification.

function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

body
ApiSpecImportRequest

The content of the action request

options
ApiDefinitionsImportSpecificationOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Imports the API specification.

function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

body
ApiSpecImportRequest

The content of the action request

options
ApiDefinitionsImportSpecificationOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

Creates new or updates existing API definition.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

resource
ApiDefinition

Resource create parameters.

options
ApiDefinitionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiDefinitionsCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

Deletes specified API definition.

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

options
ApiDefinitionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

Returns details of the API definition.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

options
ApiDefinitionsGetOptionalParams

The options parameters.

Returns

Promise<ApiDefinitionsGetResponse>

head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

Checks if specified API definition exists.

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

definitionName

string

The name of the API definition.

options
ApiDefinitionsHeadOptionalParams

The options parameters.

Returns

Promise<ApiDefinitionsHeadResponse>

list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

Returns a collection of API definitions.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

apiName

string

The name of the API.

versionName

string

The name of the API version.

options
ApiDefinitionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>