ApiDefinitions interface

Pacchetto:

@azure/arm-apicenter

Interfaccia che rappresenta un'ApiDefinitions.

Metodi

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Esporta la specifica dell'API.
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Esporta la specifica dell'API.
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importa la specifica dell'API.
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importa la specifica dell'API.
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)	Crea una definizione API nuova o aggiorna quella esistente.
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)	Elimina la definizione API specificata.
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)	Restituisce i dettagli della definizione dell'API.
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)	Controlla se la definizione API specificata esiste.
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)	Restituisce una raccolta di definizioni API.

Dettagli metodo

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

Esporta la specifica dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

options

ApiDefinitionsExportSpecificationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

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

Esporta la specifica dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

options

ApiDefinitionsExportSpecificationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiSpecExportResult>

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

Importa la specifica dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

body

ApiSpecImportRequest

Contenuto della richiesta di azione

options

ApiDefinitionsImportSpecificationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

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

Importa la specifica dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

body

ApiSpecImportRequest

Contenuto della richiesta di azione

options

ApiDefinitionsImportSpecificationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

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

Crea una definizione API nuova o aggiorna quella esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

resource

ApiDefinition

Parametri di creazione della risorsa.

options

ApiDefinitionsCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiDefinitionsCreateOrUpdateResponse>

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

Elimina la definizione API specificata.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

options

ApiDefinitionsDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

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

Restituisce i dettagli della definizione dell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

options

ApiDefinitionsGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiDefinitionsGetResponse>

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

Controlla se la definizione API specificata esiste.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

definitionName

string

Nome della definizione dell'API.

options

ApiDefinitionsHeadOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiDefinitionsHeadResponse>

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

Restituisce una raccolta di definizioni API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Centro API di Azure.

workspaceName

string

Nome dell'area di lavoro.

apiName

string

Nome dell'API.

versionName

string

Nome della versione dell'API.

options

ApiDefinitionsListOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>