ApiSchema interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący interfejs ApiSchema.

Metody

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje konfigurację schematu dla interfejsu API.
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje konfigurację schematu dla interfejsu API.
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)	Usuwa konfigurację schematu w interfejsie API.
get(string, string, string, string, ApiSchemaGetOptionalParams)	Pobierz konfigurację schematu na poziomie interfejsu API.
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) schematu określonego przez jego identyfikator.
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)	Pobierz konfigurację schematu na poziomie interfejsu API.

Szczegóły metody

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje konfigurację schematu dla interfejsu API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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.

schemaId

string

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

parameters

SchemaContract

Zawartość schematu do zastosowania.

options

ApiSchemaCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje konfigurację schematu dla interfejsu API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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.

schemaId

string

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

parameters

SchemaContract

Zawartość schematu do zastosowania.

options

ApiSchemaCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiSchemaCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Usuwa konfigurację schematu w interfejsie API.

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

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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.

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

ApiSchemaDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, ApiSchemaGetOptionalParams)

Pobierz konfigurację schematu na poziomie interfejsu API.

function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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.

schemaId

string

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

options

ApiSchemaGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiSchemaGetResponse>

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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.

schemaId

string

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

options

ApiSchemaGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ApiSchemaGetEntityTagHeaders>

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Pobierz konfigurację schematu na poziomie interfejsu API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa 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

ApiSchemaListByApiOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>