PurviewMetadataPolicyClient.GetMetadataPolicy(String, RequestOptions) Method

Definition

Namespace:

Azure.Analytics.Purview.Administration

Assembly:

Azure.Analytics.Purview.Administration.dll

Package:

Azure.Analytics.Purview.Administration v1.0.0-beta.1

Source:

PurviewMetadataPolicyClient.cs

Gets a metadata policy.

public virtual Azure.Response GetMetadataPolicy(string policyId, Azure.RequestOptions options);

abstract member GetMetadataPolicy : string * Azure.RequestOptions -> Azure.Response
override this.GetMetadataPolicy : string * Azure.RequestOptions -> Azure.Response

Public Overridable Function GetMetadataPolicy (policyId As String, options As RequestOptions) As Response

Parameters

policyId

String

Id of an existing policy that needs to be fetched.

options

Azure.RequestOptions

The request options.

Returns

Response

Exceptions

ArgumentNullException

policyId is null.

Remarks

Schema for Response Body:

{
              name: string,
              id: string,
              version: number,
              properties: {
                description: string,
                decisionRules: [
                  {
                    kind: "decisionrule" | "attributerule",
                    effect: "Deny" | "Permit",
                    dnfCondition: [AttributeMatcher[]]
                  }
                ],
                attributeRules: [
                  {
                    kind: "decisionrule" | "attributerule",
                    id: string,
                    name: string,
                    dnfCondition: [AttributeMatcher[]]
                  }
                ],
                collection: {
                  type: string,
                  referenceName: string
                },
                parentCollectionName: string
              }
            }

Schema for Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [ErrorModelAutoGenerated]
              }
            }