ApiDefinitions interface
ApiDefinitionst képviselő felület.
Metódusok
Metódus adatai
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exportálja az API-specifikációt.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
Exportálja az API-specifikációt.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
A beállítások paraméterei.
Válaszok
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importálja az API-specifikációt.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
- body
- ApiSpecImportRequest
A műveletkérés tartalma
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
Importálja az API-specifikációt.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
- body
- ApiSpecImportRequest
A műveletkérés tartalma
A beállítások paraméterei.
Válaszok
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Új vagy meglévő API-definíciót hoz létre.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
- resource
- ApiDefinition
Erőforrás-létrehozási paraméterek.
A beállítások paraméterei.
Válaszok
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
Törli a megadott API-definíciót.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
A beállítások paraméterei.
Válaszok
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
Az API-definíció részleteit adja vissza.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
- options
- ApiDefinitionsGetOptionalParams
A beállítások paraméterei.
Válaszok
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
Ellenőrzi, hogy létezik-e megadott API-definíció.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- definitionName
-
string
Az API-definíció neve.
- options
- ApiDefinitionsHeadOptionalParams
A beállítások paraméterei.
Válaszok
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
API-definíciók gyűjteményét adja vissza.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az Azure API Center szolgáltatás neve.
- workspaceName
-
string
A munkaterület neve.
- apiName
-
string
Az API neve.
- versionName
-
string
Az API-verzió neve.
- options
- ApiDefinitionsListOptionalParams
A beállítások paraméterei.