ApiDefinitions interface
Interfejs reprezentujący element ApiDefinitions.
Metody
Szczegóły metody
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Eksportuje specyfikację interfejsu API.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Eksportuje specyfikację interfejsu API.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
Parametry opcji.
Zwraca
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importuje specyfikację interfejsu API.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
- body
- ApiSpecImportRequest
Zawartość żądania akcji
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importuje specyfikację interfejsu API.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
- body
- ApiSpecImportRequest
Zawartość żądania akcji
Parametry opcji.
Zwraca
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Tworzy nową lub aktualizuje istniejącą definicję interfejsu API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
- resource
- ApiDefinition
Parametry tworzenia zasobu.
Parametry opcji.
Zwraca
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
Usuwa określoną definicję interfejsu API.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
Zwraca szczegóły definicji interfejsu API.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
- options
- ApiDefinitionsGetOptionalParams
Parametry opcji.
Zwraca
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
Sprawdza, czy określona definicja interfejsu API istnieje.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- definitionName
-
string
Nazwa definicji interfejsu API.
- options
- ApiDefinitionsHeadOptionalParams
Parametry opcji.
Zwraca
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
Zwraca kolekcję definicji interfejsu API.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi Azure API Center.
- workspaceName
-
string
Nazwa obszaru roboczego.
- apiName
-
string
Nazwa interfejsu API.
- versionName
-
string
Nazwa wersji interfejsu API.
- options
- ApiDefinitionsListOptionalParams
Parametry opcji.