Udostępnij za pośrednictwem

ApiPolicy interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Interfejs reprezentujący interfejs ApiPolicy.

Metody

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje konfigurację zasad dla interfejsu API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Usuwa konfigurację zasad w interfejsie API.
get(string, string, string, string, ApiPolicyGetOptionalParams)

Pobierz konfigurację zasad na poziomie interfejsu API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) zasad interfejsu API określonego przez jego identyfikator.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Pobierz konfigurację zasad na poziomie interfejsu API.

Szczegóły metody

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje konfigurację zasad dla interfejsu API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

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.

policyId

string

Identyfikator zasad.

parameters
PolicyContract

Zawartość zasad do zastosowania.

options
ApiPolicyCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Usuwa konfigurację zasad w interfejsie API.

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

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
ApiPolicyDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

Pobierz konfigurację zasad na poziomie interfejsu API.

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

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.

policyId

string

Identyfikator zasad.

options
ApiPolicyGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

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.

policyId

string

Identyfikator zasad.

options
ApiPolicyGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Pobierz konfigurację zasad na poziomie interfejsu API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

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
ApiPolicyListByApiOptionalParams

Parametry opcji.

Zwraca

Promise<PolicyCollection>