WorkspaceApi interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący interfejs WorkspaceApi.

Metody

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Tworzy nowy lub aktualizuje istniejący określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Tworzy nowy lub aktualizuje istniejący określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	Usuwa określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	Pobiera szczegóły interfejsu API określonego przez jego identyfikator.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) interfejsu API określonego przez jego identyfikator.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	Wyświetla listę wszystkich interfejsów API obszaru roboczego w wystąpieniu usługi API Management.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	Aktualizuje określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.

Szczegóły metody

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Tworzy nowy lub aktualizuje istniejący określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

parameters

ApiCreateOrUpdateParameter

Tworzenie lub aktualizowanie parametrów.

options

WorkspaceApiCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Tworzy nowy lub aktualizuje istniejący określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

parameters

ApiCreateOrUpdateParameter

Tworzenie lub aktualizowanie parametrów.

options

WorkspaceApiCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)

Usuwa określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

options

WorkspaceApiDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, WorkspaceApiGetOptionalParams)

Pobiera szczegóły interfejsu API określonego przez jego identyfikator.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

options

WorkspaceApiGetOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiGetResponse>

getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) interfejsu API określonego przez jego identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

options

WorkspaceApiGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

Wyświetla listę wszystkich interfejsów API obszaru roboczego w wystąpieniu usługi API Management.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

WorkspaceApiListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)

Aktualizuje określony interfejs API obszaru roboczego w wystąpieniu usługi API Management.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

parameters

ApiUpdateContract

Parametry kontraktu aktualizacji interfejsu API.

options

WorkspaceApiUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiUpdateResponse>