ApiOperationPolicy interface
Interfejs reprezentujący obiekt ApiOperationPolicy.
Metody
create |
Tworzy lub aktualizuje konfigurację zasad dla poziomu operacji interfejsu API. |
delete(string, string, string, string, string, string, Api |
Usuwa konfigurację zasad w operacji interfejsu API. |
get(string, string, string, string, string, Api |
Pobierz konfigurację zasad na poziomie operacji interfejsu API. |
get |
Pobiera wersję stanu jednostki (Etag) zasad operacji interfejsu API określonych przez jego identyfikator. |
list |
Pobierz listę konfiguracji zasad na poziomie operacji interfejsu API. |
Szczegóły metody
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje konfigurację zasad dla poziomu operacji interfejsu API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- 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.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Usuwa konfigurację zasad w operacji interfejsu API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- 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
ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Pobierz konfigurację zasad na poziomie operacji interfejsu API.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- operationId
-
string
Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- policyId
-
string
Identyfikator zasad.
Parametry opcji.
Zwraca
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) zasad operacji interfejsu API określonych przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- operationId
-
string
Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- policyId
-
string
Identyfikator zasad.
Parametry opcji.
Zwraca
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Pobierz listę konfiguracji zasad na poziomie operacji interfejsu API.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- operationId
-
string
Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<PolicyCollection>