PolicyDefinitionsListBuiltInOptionalParams interface

パッケージ:

@azure/arm-policy

省略可能なパラメーター。

Extends

OperationOptions

プロパティ

filter

操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー定義のみが含まれます。

top

返されるレコードの最大数。 $top フィルターが指定されていない場合は、500 個のレコードが返されます。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

filter

操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー定義のみが含まれます。

filter?: string

プロパティ値

string

top

返されるレコードの最大数。 $top フィルターが指定されていない場合は、500 個のレコードが返されます。

top?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

coreClient.OperationOptions.abortSignal から継承

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

coreClient.OperationOptions.onResponse から継承

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

coreClient.OperationOptions.requestOptions から継承

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

coreClient.OperationOptions.serializerOptions から継承

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

coreClient.OperationOptions.tracingOptions から継承