Bagikan melalui


ApiDefinitions interface

Antarmuka yang mewakili ApiDefinitions.

Metode

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

Mengekspor spesifikasi API.

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

Mengekspor spesifikasi API.

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

Mengimpor spesifikasi API.

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

Mengimpor spesifikasi API.

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

Membuat definisi API baru atau memperbarui yang ada.

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

Menghapus definisi API yang ditentukan.

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

Mengembalikan detail definisi API.

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

Memeriksa apakah definisi API yang ditentukan ada.

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

Mengembalikan kumpulan definisi API.

Detail Metode

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

Mengekspor spesifikasi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

Mengembalikan

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

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

Mengekspor spesifikasi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

Mengembalikan

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

Mengimpor spesifikasi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

body
ApiSpecImportRequest

Konten permintaan tindakan

Mengembalikan

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

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

Mengimpor spesifikasi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

body
ApiSpecImportRequest

Konten permintaan tindakan

Mengembalikan

Promise<void>

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

Membuat definisi API baru atau memperbarui yang ada.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

resource
ApiDefinition

Parameter pembuatan sumber daya.

Mengembalikan

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

Menghapus definisi API yang ditentukan.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

options
ApiDefinitionsDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

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

Mengembalikan detail definisi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

options
ApiDefinitionsGetOptionalParams

Parameter opsi.

Mengembalikan

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

Memeriksa apakah definisi API yang ditentukan ada.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

definitionName

string

Nama definisi API.

options
ApiDefinitionsHeadOptionalParams

Parameter opsi.

Mengembalikan

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

Mengembalikan kumpulan definisi API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan Azure API Center.

workspaceName

string

Nama ruang kerja.

apiName

string

Nama API.

versionName

string

Nama versi API.

options
ApiDefinitionsListOptionalParams

Parameter opsi.

Mengembalikan