ApiDefinitions interface
ApiDefinitions'i temsil eden arabirim.
Yöntemler
Yöntem Ayrıntıları
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API belirtimini dışarı aktarır.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API belirtimini dışarı aktarır.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API belirtimini içeri aktarır.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
- body
- ApiSpecImportRequest
Eylem isteğinin içeriği
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API belirtimini içeri aktarır.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
- body
- ApiSpecImportRequest
Eylem isteğinin içeriği
Seçenekler parametreleri.
Döndürülenler
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Yeni api tanımı oluşturur veya mevcut API tanımını güncelleştirir.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
- resource
- ApiDefinition
Kaynak oluşturma parametreleri.
Seçenekler parametreleri.
Döndürülenler
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
Belirtilen API tanımını siler.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
Seçenekler parametreleri.
Döndürülenler
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
API tanımının ayrıntılarını döndürür.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
- options
- ApiDefinitionsGetOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
Belirtilen API tanımının mevcut olup olmadığını denetler.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- definitionName
-
string
API tanımının adı.
- options
- ApiDefinitionsHeadOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
API tanımlarından oluşan bir koleksiyon döndürür.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>
Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
Azure API Center hizmetinin adı.
- workspaceName
-
string
Çalışma alanının adı.
- apiName
-
string
API'nin adı.
- versionName
-
string
API sürümünün adı.
- options
- ApiDefinitionsListOptionalParams
Seçenekler parametreleri.