Sdílet prostřednictvím


ApiDefinitions interface

Rozhraní představující apiDefinitions

Metody

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

Exportuje specifikaci rozhraní API.

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

Exportuje specifikaci rozhraní API.

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

Importuje specifikaci rozhraní API.

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

Importuje specifikaci rozhraní API.

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

Vytvoří novou nebo aktualizuje existující definici rozhraní API.

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

Odstraní zadanou definici rozhraní API.

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

Vrátí podrobnosti definice rozhraní API.

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

Zkontroluje, jestli existuje zadaná definice rozhraní API.

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

Vrátí kolekci definic rozhraní API.

Podrobnosti metody

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

Exportuje specifikaci rozhraní 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

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

options
ApiDefinitionsExportSpecificationOptionalParams

Parametry možností.

Návraty

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

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

Exportuje specifikaci rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

options
ApiDefinitionsExportSpecificationOptionalParams

Parametry možností.

Návraty

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

Importuje specifikaci rozhraní 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

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

body
ApiSpecImportRequest

Obsah žádosti o akci

options
ApiDefinitionsImportSpecificationOptionalParams

Parametry možností.

Návraty

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

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

Importuje specifikaci rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

body
ApiSpecImportRequest

Obsah žádosti o akci

options
ApiDefinitionsImportSpecificationOptionalParams

Parametry možností.

Návraty

Promise<void>

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

Vytvoří novou nebo aktualizuje existující definici rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

resource
ApiDefinition

Parametry vytvoření prostředku

options
ApiDefinitionsCreateOrUpdateOptionalParams

Parametry možností.

Návraty

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

Odstraní zadanou definici rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

options
ApiDefinitionsDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

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

Vrátí podrobnosti definice rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

options
ApiDefinitionsGetOptionalParams

Parametry možností.

Návraty

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

Zkontroluje, jestli existuje zadaná definice rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

definitionName

string

Název definice rozhraní API.

options
ApiDefinitionsHeadOptionalParams

Parametry možností.

Návraty

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

Vrátí kolekci definic rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby Azure API Center.

workspaceName

string

Název pracovního prostoru.

apiName

string

Název rozhraní API.

versionName

string

Název verze rozhraní API.

options
ApiDefinitionsListOptionalParams

Parametry možností.

Návraty