PolicyFragment interface

Package:

@azure/arm-apimanagement

Interface representing a PolicyFragment.

Methods

beginCreateOrUpdate(string, string, string, PolicyFragmentContract, PolicyFragmentCreateOrUpdateOptionalParams)	Creates or updates a policy fragment.
beginCreateOrUpdateAndWait(string, string, string, PolicyFragmentContract, PolicyFragmentCreateOrUpdateOptionalParams)	Creates or updates a policy fragment.
delete(string, string, string, string, PolicyFragmentDeleteOptionalParams)	Deletes a policy fragment.
get(string, string, string, PolicyFragmentGetOptionalParams)	Gets a policy fragment.
getEntityTag(string, string, string, PolicyFragmentGetEntityTagOptionalParams)	Gets the entity state (Etag) version of a policy fragment.
listByService(string, string, PolicyFragmentListByServiceOptionalParams)	Gets all policy fragments.
listReferences(string, string, string, PolicyFragmentListReferencesOptionalParams)	Lists policy resources that reference the policy fragment.

Method Details

beginCreateOrUpdate(string, string, string, PolicyFragmentContract, PolicyFragmentCreateOrUpdateOptionalParams)

Creates or updates a policy fragment.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, id: string, parameters: PolicyFragmentContract, options?: PolicyFragmentCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PolicyFragmentCreateOrUpdateResponse>, PolicyFragmentCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

parameters

PolicyFragmentContract

The policy fragment contents to apply.

options

PolicyFragmentCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PolicyFragmentCreateOrUpdateResponse>, PolicyFragmentCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, PolicyFragmentContract, PolicyFragmentCreateOrUpdateOptionalParams)

Creates or updates a policy fragment.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, id: string, parameters: PolicyFragmentContract, options?: PolicyFragmentCreateOrUpdateOptionalParams): Promise<PolicyFragmentCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

parameters

PolicyFragmentContract

The policy fragment contents to apply.

options

PolicyFragmentCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PolicyFragmentCreateOrUpdateResponse>

delete(string, string, string, string, PolicyFragmentDeleteOptionalParams)

Deletes a policy fragment.

function delete(resourceGroupName: string, serviceName: string, id: string, ifMatch: string, options?: PolicyFragmentDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options

PolicyFragmentDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PolicyFragmentGetOptionalParams)

Gets a policy fragment.

function get(resourceGroupName: string, serviceName: string, id: string, options?: PolicyFragmentGetOptionalParams): Promise<PolicyFragmentGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

options

PolicyFragmentGetOptionalParams

The options parameters.

Returns

Promise<PolicyFragmentGetResponse>

getEntityTag(string, string, string, PolicyFragmentGetEntityTagOptionalParams)

Gets the entity state (Etag) version of a policy fragment.

function getEntityTag(resourceGroupName: string, serviceName: string, id: string, options?: PolicyFragmentGetEntityTagOptionalParams): Promise<PolicyFragmentGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

options

PolicyFragmentGetEntityTagOptionalParams

The options parameters.

Returns

Promise<PolicyFragmentGetEntityTagHeaders>

listByService(string, string, PolicyFragmentListByServiceOptionalParams)

Gets all policy fragments.

function listByService(resourceGroupName: string, serviceName: string, options?: PolicyFragmentListByServiceOptionalParams): Promise<PolicyFragmentCollection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options

PolicyFragmentListByServiceOptionalParams

The options parameters.

Returns

Promise<PolicyFragmentCollection>

listReferences(string, string, string, PolicyFragmentListReferencesOptionalParams)

Lists policy resources that reference the policy fragment.

function listReferences(resourceGroupName: string, serviceName: string, id: string, options?: PolicyFragmentListReferencesOptionalParams): Promise<ResourceCollection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

id

string

A resource identifier.

options

PolicyFragmentListReferencesOptionalParams

The options parameters.

Returns

Promise<ResourceCollection>