@datafire/azure_resources_policy v5.0.0
@datafire/azure_resources_policy
Client library for PolicyClient
Installation and Usage
npm install --save @datafire/azure_resources_policy
let azure_resources_policy = require('@datafire/azure_resources_policy').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
To manage and control access to your resources, you can define customized policies and assign them at a scope.
Actions
PolicyAssignments_List
Gets all the policy assignments for a subscription.
azure_resources_policy.PolicyAssignments_List({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- $filter
Output
- output PolicyAssignmentListResult
PolicyDefinitions_List
Gets all the policy definitions for a subscription.
azure_resources_policy.PolicyDefinitions_List({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- $filter
Output
- output PolicyDefinitionListResult
PolicyDefinitions_Delete
Deletes a policy definition.
azure_resources_policy.PolicyDefinitions_Delete({
"policyDefinitionName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- policyDefinitionName required
string
: The name of the policy definition to delete. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- policyDefinitionName required
Output
Output schema unknown
PolicyDefinitions_Get
Gets the policy definition.
azure_resources_policy.PolicyDefinitions_Get({
"policyDefinitionName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- policyDefinitionName required
string
: The name of the policy definition to get. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- policyDefinitionName required
Output
- output PolicyDefinition
PolicyDefinitions_CreateOrUpdate
Creates or updates a policy definition.
azure_resources_policy.PolicyDefinitions_CreateOrUpdate({
"policyDefinitionName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- policyDefinitionName required
string
: The name of the policy definition to create. - parameters required PolicyDefinition
- api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- policyDefinitionName required
Output
- output PolicyDefinition
PolicyAssignments_ListForResourceGroup
Gets policy assignments for the resource group.
azure_resources_policy.PolicyAssignments_ListForResourceGroup({
"resourceGroupName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains policy assignments. - $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output PolicyAssignmentListResult
PolicyAssignments_ListForResource
Gets policy assignments for a resource.
azure_resources_policy.PolicyAssignments_ListForResource({
"resourceGroupName": "",
"resourceProviderNamespace": "",
"parentResourcePath": "",
"resourceType": "",
"resourceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group containing the resource. The name is case insensitive. - resourceProviderNamespace required
string
: The namespace of the resource provider. - parentResourcePath required
string
: The parent resource path. - resourceType required
string
: The resource type. - resourceName required
string
: The name of the resource with policy assignments. - $filter
string
: The filter to apply on the operation. - api-version required
string
: The API version to use for the operation. - subscriptionId required
string
: The ID of the target subscription.
- resourceGroupName required
Output
- output PolicyAssignmentListResult
PolicyAssignments_DeleteById
When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
azure_resources_policy.PolicyAssignments_DeleteById({
"policyAssignmentId": "",
"api-version": ""
}, context)
Input
- input
object
- policyAssignmentId required
string
: The ID of the policy assignment to delete. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. - api-version required
string
: The API version to use for the operation.
- policyAssignmentId required
Output
- output PolicyAssignment
PolicyAssignments_GetById
When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
azure_resources_policy.PolicyAssignments_GetById({
"policyAssignmentId": "",
"api-version": ""
}, context)
Input
- input
object
- policyAssignmentId required
string
: The ID of the policy assignment to get. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. - api-version required
string
: The API version to use for the operation.
- policyAssignmentId required
Output
- output PolicyAssignment
PolicyAssignments_CreateById
Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
azure_resources_policy.PolicyAssignments_CreateById({
"policyAssignmentId": "",
"parameters": null,
"api-version": ""
}, context)
Input
- input
object
- policyAssignmentId required
string
: The ID of the policy assignment to create. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. - parameters required PolicyAssignment
- api-version required
string
: The API version to use for the operation.
- policyAssignmentId required
Output
- output PolicyAssignment
PolicyAssignments_Delete
Deletes a policy assignment.
azure_resources_policy.PolicyAssignments_Delete({
"scope": "",
"policyAssignmentName": "",
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: The scope of the policy assignment. - policyAssignmentName required
string
: The name of the policy assignment to delete. - api-version required
string
: The API version to use for the operation.
- scope required
Output
- output PolicyAssignment
PolicyAssignments_Get
Gets a policy assignment.
azure_resources_policy.PolicyAssignments_Get({
"scope": "",
"policyAssignmentName": "",
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: The scope of the policy assignment. - policyAssignmentName required
string
: The name of the policy assignment to get. - api-version required
string
: The API version to use for the operation.
- scope required
Output
- output PolicyAssignment
PolicyAssignments_Create
Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.
azure_resources_policy.PolicyAssignments_Create({
"scope": "",
"policyAssignmentName": "",
"parameters": null,
"api-version": ""
}, context)
Input
- input
object
- scope required
string
: The scope of the policy assignment. - policyAssignmentName required
string
: The name of the policy assignment. - parameters required PolicyAssignment
- api-version required
string
: The API version to use for the operation.
- scope required
Output
- output PolicyAssignment
Definitions
PolicyAssignment
- PolicyAssignment
object
: The policy assignment.- id
string
: The ID of the policy assignment. - name
string
: The name of the policy assignment. - properties PolicyAssignmentProperties
- type
string
: The type of the policy assignment.
- id
PolicyAssignmentListResult
- PolicyAssignmentListResult
object
: List of policy assignments.- nextLink
string
: The URL to use for getting the next set of results. - value
array
: An array of policy assignments.- items PolicyAssignment
- nextLink
PolicyAssignmentProperties
- PolicyAssignmentProperties
object
: The policy assignment properties.- displayName
string
: The display name of the policy assignment. - policyDefinitionId
string
: The ID of the policy definition. - scope
string
: The scope for the policy assignment.
- displayName
PolicyDefinition
- PolicyDefinition
object
: The policy definition.- id
string
: The ID of the policy definition. - name
string
: The name of the policy definition. If you do not specify a value for name, the value is inferred from the name value in the request URI. - properties PolicyDefinitionProperties
- id
PolicyDefinitionListResult
- PolicyDefinitionListResult
object
: List of policy definitions.- nextLink
string
: The URL to use for getting the next set of results. - value
array
: An array of policy definitions.- items PolicyDefinition
- nextLink
PolicyDefinitionProperties
- PolicyDefinitionProperties
object
: The policy definition properties.- description
string
: The policy definition description. - displayName
string
: The display name of the policy definition. - policyRule
object
: The policy rule. - policyType
string
(values: NotSpecified, BuiltIn, Custom): The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom.
- description