WorkspaceApiPolicy interface
Interfejs reprezentujący element WorkspaceApiPolicy.
Metody
| create |
Tworzy lub aktualizuje konfigurację zasad dla interfejsu API. |
| delete(string, string, string, string, string, string, Workspace |
Usuwa konfigurację zasad w interfejsie API. |
| get(string, string, string, string, string, Workspace |
Pobierz konfigurację zasad na poziomie interfejsu API. |
| get |
Pobiera wersję stanu jednostki (Etag) zasad interfejsu API określonego przez jego identyfikator. |
| list |
Pobierz konfigurację zasad na poziomie interfejsu API. |
Szczegóły metody
createOrUpdate(string, string, string, string, string, PolicyContract, WorkspaceApiPolicyCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje konfigurację zasad dla interfejsu API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiPolicyCreateOrUpdateResponse>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.
- policyId
-
string
Identyfikator zasad.
- parameters
- PolicyContract
Zawartość zasad do zastosowania.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, string, WorkspaceApiPolicyDeleteOptionalParams)
Usuwa konfigurację zasad w interfejsie API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, ifMatch: string, options?: WorkspaceApiPolicyDeleteOptionalParams): 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.
- 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.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, string, WorkspaceApiPolicyGetOptionalParams)
Pobierz konfigurację zasad na poziomie interfejsu API.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetOptionalParams): Promise<WorkspaceApiPolicyGetResponse>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.
- policyId
-
string
Identyfikator zasad.
Parametry opcji.
Zwraca
Promise<WorkspaceApiPolicyGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiPolicyGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) zasad interfejsu API określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiPolicyGetEntityTagHeaders>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.
- policyId
-
string
Identyfikator zasad.
Parametry opcji.
Zwraca
listByApi(string, string, string, string, WorkspaceApiPolicyListByApiOptionalParams)
Pobierz konfigurację zasad na poziomie interfejsu API.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiPolicyListByApiOptionalParams): 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.
Parametry opcji.