Azure.Analytics.Purview.MetadataPolicies (preview:2021-07-01)

2025/12/05 • 4 deleted methods

MetadataRoles_List (removed)
Description :  Lists roles for Purview Account
Reference :  Link ¶

⚼ Request

GET:  /metadataRoles
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
values:
{
Required: True ,
}
[
{
id:
{
Description: The Id of role ,
Required: False ,
}
string ,
name:
{
Description: The name of role ,
Required: False ,
}
string ,
type:
{
Description: The type of role ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioningState of role ,
Required: False ,
}
string ,
roleType:
{
Description: The type of role ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of role ,
Required: False ,
}
string ,
description:
{
Description: The description of role ,
Required: False ,
}
string ,
cnfCondition:
{
Description: The cnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
version:
{
Description: The version of role ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The error response model for metadata policy ,
}
{
error:
{
Description: The error model for metadata policy ,
Required: True ,
}
{
code:
{
Description: The error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
target:
{
Description: The error target ,
Required: False ,
}
string ,
details:
{
Description: The error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
MetadataPolicy_ListAll (removed)
Description :  List or Get metadata policies
Reference :  Link ¶

⚼ Request

GET:  /metadataPolicies
{
collectionName:
{
Description: The name of an existing collection for which one policy needs to be fetched. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
values:
{
Required: True ,
}
[
{
name:
{
Description: The name of policy ,
Required: False ,
}
string ,
id:
{
Description: The id of policy ,
Required: False ,
}
string ,
version:
{
Description: The version of policy ,
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Required: False ,
}
{
description:
{
Description: The description of policy ,
Required: False ,
}
string ,
decisionRules:
{
Description: The DecisionRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
decisionrule: No description available. ,
}
,
Required: False ,
}
enum ,
effect:
{
Description: The effect for rule ,
Enum:
{
Deny: No description available. ,
Permit: No description available. ,
}
,
Required: False ,
}
enum ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The AttributeRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
attributerule: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The id for rule ,
Required: False ,
}
string ,
name:
{
Description: The name for rule ,
Required: False ,
}
string ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
collection:
{
Description: The collection reference for a policy ,
Required: False ,
}
{
type:
{
Description: The type of reference ,
Required: False ,
}
string ,
referenceName:
{
Description: The name of reference ,
Required: False ,
}
string ,
}
,
parentCollectionName:
{
Description: The parent collection of the policy ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The error response model for metadata policy ,
}
{
error:
{
Description: The error model for metadata policy ,
Required: True ,
}
{
code:
{
Description: The error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
target:
{
Description: The error target ,
Required: False ,
}
string ,
details:
{
Description: The error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
MetadataPolicy_Update (removed)
Description :  Updates a metadata policy
Reference :  Link ¶

⚼ Request

PUT:  /metadataPolicies/{policyId}
{
policyId:
{
Description: Unique policy id. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Description: Policy to be updated. ,
Required: False ,
}
{
name:
{
Description: The name of policy ,
Required: False ,
}
string ,
id:
{
Description: The id of policy ,
Required: False ,
}
string ,
version:
{
Description: The version of policy ,
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Required: False ,
}
{
description:
{
Description: The description of policy ,
Required: False ,
}
string ,
decisionRules:
{
Description: The DecisionRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
decisionrule: No description available. ,
}
,
Required: False ,
}
enum ,
effect:
{
Description: The effect for rule ,
Enum:
{
Deny: No description available. ,
Permit: No description available. ,
}
,
Required: False ,
}
enum ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The AttributeRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
attributerule: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The id for rule ,
Required: False ,
}
string ,
name:
{
Description: The name for rule ,
Required: False ,
}
string ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
collection:
{
Description: The collection reference for a policy ,
Required: False ,
}
{
type:
{
Description: The type of reference ,
Required: False ,
}
string ,
referenceName:
{
Description: The name of reference ,
Required: False ,
}
string ,
}
,
parentCollectionName:
{
Description: The parent collection of the policy ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of policy ,
Required: False ,
}
string ,
id:
{
Description: The id of policy ,
Required: False ,
}
string ,
version:
{
Description: The version of policy ,
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Required: False ,
}
{
description:
{
Description: The description of policy ,
Required: False ,
}
string ,
decisionRules:
{
Description: The DecisionRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
decisionrule: No description available. ,
}
,
Required: False ,
}
enum ,
effect:
{
Description: The effect for rule ,
Enum:
{
Deny: No description available. ,
Permit: No description available. ,
}
,
Required: False ,
}
enum ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The AttributeRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
attributerule: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The id for rule ,
Required: False ,
}
string ,
name:
{
Description: The name for rule ,
Required: False ,
}
string ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
collection:
{
Description: The collection reference for a policy ,
Required: False ,
}
{
type:
{
Description: The type of reference ,
Required: False ,
}
string ,
referenceName:
{
Description: The name of reference ,
Required: False ,
}
string ,
}
,
parentCollectionName:
{
Description: The parent collection of the policy ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The error response model for metadata policy ,
}
{
error:
{
Description: The error model for metadata policy ,
Required: True ,
}
{
code:
{
Description: The error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
target:
{
Description: The error target ,
Required: False ,
}
string ,
details:
{
Description: The error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
MetadataPolicy_Get (removed)
Description :  Gets a metadata policy
Reference :  Link ¶

⚼ Request

GET:  /metadataPolicies/{policyId}
{
policyId:
{
Description: Id of an existing policy that needs to be fetched. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of policy ,
Required: False ,
}
string ,
id:
{
Description: The id of policy ,
Required: False ,
}
string ,
version:
{
Description: The version of policy ,
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Required: False ,
}
{
description:
{
Description: The description of policy ,
Required: False ,
}
string ,
decisionRules:
{
Description: The DecisionRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
decisionrule: No description available. ,
}
,
Required: False ,
}
enum ,
effect:
{
Description: The effect for rule ,
Enum:
{
Deny: No description available. ,
Permit: No description available. ,
}
,
Required: False ,
}
enum ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The AttributeRules of policy ,
Required: False ,
}
[
{
kind:
{
Description: The kind of rule ,
Enum:
{
attributerule: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The id for rule ,
Required: False ,
}
string ,
name:
{
Description: The name for rule ,
Required: False ,
}
string ,
dnfCondition:
{
Description: The dnf Condition for a rule ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName ,
Required: False ,
}
string ,
attributeValueIncludes:
{
Description: Value for attribute ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: List of values for attribute ,
Required: False ,
}
[
string ,
]
,
attributeValueExcludes:
{
Description: Value excluded for attribute ,
Required: False ,
}
string ,
attributeValueExcludedIn:
{
Description: List of values excluded for attribute ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
collection:
{
Description: The collection reference for a policy ,
Required: False ,
}
{
type:
{
Description: The type of reference ,
Required: False ,
}
string ,
referenceName:
{
Description: The name of reference ,
Required: False ,
}
string ,
}
,
parentCollectionName:
{
Description: The parent collection of the policy ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The error response model for metadata policy ,
}
{
error:
{
Description: The error model for metadata policy ,
Required: True ,
}
{
code:
{
Description: The error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
target:
{
Description: The error target ,
Required: False ,
}
string ,
details:
{
Description: The error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}