ApiPolicyCollection.CreateOrUpdate Method

Definition

Creates or updates policy configuration for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
  • Operation Id: ApiPolicy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiPolicyResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiPolicyResource> CreateOrUpdate (Azure.WaitUntil waitUntil, Azure.ResourceManager.ApiManagement.Models.PolicyName policyId, Azure.ResourceManager.ApiManagement.PolicyContractData data, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * Azure.ResourceManager.ApiManagement.Models.PolicyName * Azure.ResourceManager.ApiManagement.PolicyContractData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiPolicyResource>
override this.CreateOrUpdate : Azure.WaitUntil * Azure.ResourceManager.ApiManagement.Models.PolicyName * Azure.ResourceManager.ApiManagement.PolicyContractData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiPolicyResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, policyId As PolicyName, data As PolicyContractData, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of ApiPolicyResource)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

policyId
PolicyName

The identifier of the Policy.

data
PolicyContractData

The policy contents to apply.

ifMatch
Nullable<ETag>

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

data is null.

Applies to