ApiPolicy interface
Interface die een ApiPolicy vertegenwoordigt.
Methoden
| create |
Hiermee wordt de beleidsconfiguratie voor de API gemaakt of bijgewerkt. |
| delete(string, string, string, string, string, Api |
Hiermee verwijdert u de beleidsconfiguratie op de API. |
| get(string, string, string, string, Api |
Haal de beleidsconfiguratie op API-niveau op. |
| get |
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het API-beleid dat is opgegeven door de id. |
| list |
Haal de beleidsconfiguratie op API-niveau op. |
Methodedetails
createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)
Hiermee wordt de beleidsconfiguratie voor de API gemaakt of bijgewerkt.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.
- policyId
-
string
De id van het beleid.
- parameters
- PolicyContract
De beleidsinhoud die moet worden toegepast.
De optiesparameters.
Retouren
Promise<ApiPolicyCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)
Hiermee verwijdert u de beleidsconfiguratie op de API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.
- policyId
-
string
De id van het beleid.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- options
- ApiPolicyDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, string, ApiPolicyGetOptionalParams)
Haal de beleidsconfiguratie op API-niveau op.
function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.
- policyId
-
string
De id van het beleid.
- options
- ApiPolicyGetOptionalParams
De optiesparameters.
Retouren
Promise<ApiPolicyGetResponse>
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het API-beleid dat is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.
- policyId
-
string
De id van het beleid.
De optiesparameters.
Retouren
Promise<ApiPolicyGetEntityTagHeaders>
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)
Haal de beleidsconfiguratie op API-niveau op.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.
- options
- ApiPolicyListByApiOptionalParams
De optiesparameters.
Retouren
Promise<PolicyCollection>