GlobalSchema interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący globalschemę.

Metody

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)	Tworzy nowy lub aktualizuje istniejący określony schemat wystąpienia usługi API Management.
beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)	Tworzy nowy lub aktualizuje istniejący określony schemat wystąpienia usługi API Management.
delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)	Usuwa określony schemat.
get(string, string, string, GlobalSchemaGetOptionalParams)	Pobiera szczegóły schematu określonego przez jego identyfikator.
getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) schematu określonego przez jego identyfikator.
listByService(string, string, GlobalSchemaListByServiceOptionalParams)	Wyświetla listę kolekcji schematów zarejestrowanych w wystąpieniu usługi.

Szczegóły metody

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Tworzy nowy lub aktualizuje istniejący określony schemat wystąpienia usługi API Management.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

schemaId

string

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

parameters

GlobalSchemaContract

Tworzenie lub aktualizowanie parametrów.

options

GlobalSchemaCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Tworzy nowy lub aktualizuje istniejący określony schemat wystąpienia usługi API Management.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

schemaId

string

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

parameters

GlobalSchemaContract

Tworzenie lub aktualizowanie parametrów.

options

GlobalSchemaCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<GlobalSchemaCreateOrUpdateResponse>

delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)

Usuwa określony schemat.

function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

schemaId

string

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

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

GlobalSchemaDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, GlobalSchemaGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

schemaId

string

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

options

GlobalSchemaGetOptionalParams

Parametry opcji.

Zwraca

Promise<GlobalSchemaGetResponse>

getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

schemaId

string

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

options

GlobalSchemaGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<GlobalSchemaGetEntityTagHeaders>

listByService(string, string, GlobalSchemaListByServiceOptionalParams)

Wyświetla listę kolekcji schematów zarejestrowanych w wystąpieniu usługi.

function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

options

GlobalSchemaListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>