WorkspaceApiOperationPolicy interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący element WorkspaceApiOperationPolicy.

Metody

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje konfigurację zasad dla poziomu operacji interfejsu API.
delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)	Usuwa konfigurację zasad w operacji interfejsu API.
get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)	Pobierz konfigurację zasad na poziomie operacji interfejsu API.
getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) zasad operacji interfejsu API określonych przez jego identyfikator.
listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)	Pobierz listę konfiguracji zasad na poziomie operacji interfejsu API.

Szczegóły metody

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje konfigurację zasad dla poziomu operacji interfejsu API.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

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.

operationId

string

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

policyId

string

Identyfikator zasad.

parameters

PolicyContract

Zawartość zasad do zastosowania.

options

WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)

Usuwa konfigurację zasad w operacji interfejsu API.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: WorkspaceApiOperationPolicyDeleteOptionalParams): 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.

operationId

string

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

policyId

string

Identyfikator zasad.

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

WorkspaceApiOperationPolicyDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)

Pobierz konfigurację zasad na poziomie operacji interfejsu API.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetOptionalParams): Promise<WorkspaceApiOperationPolicyGetResponse>

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.

operationId

string

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

policyId

string

Identyfikator zasad.

options

WorkspaceApiOperationPolicyGetOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

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.

operationId

string

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

policyId

string

Identyfikator zasad.

options

WorkspaceApiOperationPolicyGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)

Pobierz listę konfiguracji zasad na poziomie operacji interfejsu API.

function listByOperation(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationPolicyListByOperationOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], 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.

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.

operationId

string

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

options

WorkspaceApiOperationPolicyListByOperationOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>