ApiOperationPolicy interface
Gränssnitt som representerar en ApiOperationPolicy.
Metoder
| create |
Skapar eller uppdaterar principkonfigurationen för API-åtgärdsnivån. |
| delete(string, string, string, string, string, string, Api |
Tar bort principkonfigurationen i API-åtgärden. |
| get(string, string, string, string, string, Api |
Hämta principkonfigurationen på API-åtgärdsnivå. |
| get |
Hämtar entitetstillståndsversionen (Etag) för DEN API-åtgärdsprincip som anges av dess identifierare. |
| list |
Hämta listan över principkonfiguration på API-åtgärdsnivå. |
Metodinformation
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Skapar eller uppdaterar principkonfigurationen för API-åtgärdsnivån.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- operationId
-
string
Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- policyId
-
string
Principens identifierare.
- parameters
- PolicyContract
Det principinnehåll som ska tillämpas.
Alternativparametrarna.
Returer
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Tar bort principkonfigurationen i API-åtgärden.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- operationId
-
string
Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- policyId
-
string
Principens identifierare.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Hämta principkonfigurationen på API-åtgärdsnivå.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- operationId
-
string
Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- policyId
-
string
Principens identifierare.
Alternativparametrarna.
Returer
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Hämtar entitetstillståndsversionen (Etag) för DEN API-åtgärdsprincip som anges av dess identifierare.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- operationId
-
string
Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- policyId
-
string
Principens identifierare.
Alternativparametrarna.
Returer
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Hämta listan över principkonfiguration på API-åtgärdsnivå.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- operationId
-
string
Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<PolicyCollection>