policyinsights

package
v15.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package policyinsights implements the Azure ARM Policyinsights service API version 2017-08-09-preview.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Policyinsights
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Policyinsights.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Column 

type Column struct {
	// Ordinal - Ordinal value of the column in a record.
	Ordinal *int32 `json:"ordinal,omitempty"`
	// Name - Name of the column.
	Name *string `json:"name,omitempty"`
	// DataType - Data type of the column.
	DataType *string `json:"dataType,omitempty"`
}

Column column definition.

type Operation 

type Operation struct {
	// Name - Operation name.
	Name *string `json:"name,omitempty"`
	// Display - Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation operation definition.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Resource provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource name on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation name.
	Operation *string `json:"operation,omitempty"`
	// Description - Operation description.
	Description *string `json:"description,omitempty"`
}

OperationDisplay display metadata associated with the operation.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Policyinsights service.

func NewOperationsClient 

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationsListResults, err error)

List lists available operations.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsListResults, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationsListResults 

type OperationsListResults struct {
	autorest.Response `json:"-"`
	// Value - List of available operations.
	Value *[]Operation `json:"value,omitempty"`
}

OperationsListResults list of available operations.

type PolicyEventsClient 

type PolicyEventsClient struct {
	BaseClient
}

PolicyEventsClient is the client for the PolicyEvents methods of the Policyinsights service.

func NewPolicyEventsClient 

func NewPolicyEventsClient() PolicyEventsClient

NewPolicyEventsClient creates an instance of the PolicyEventsClient client.

func NewPolicyEventsClientWithBaseURI 

func NewPolicyEventsClientWithBaseURI(baseURI string) PolicyEventsClient

NewPolicyEventsClientWithBaseURI creates an instance of the PolicyEventsClient client.

func (PolicyEventsClient) ListQueryResultsForManagementGroup 

func (client PolicyEventsClient) ListQueryResultsForManagementGroup(ctx context.Context, managementGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyEventsQueryResults, err error)

ListQueryResultsForManagementGroup queries policy events for the resources under the management group.

managementGroupName is management group name. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyEventsClient) ListQueryResultsForManagementGroupPreparer 

func (client PolicyEventsClient) ListQueryResultsForManagementGroupPreparer(ctx context.Context, managementGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForManagementGroupPreparer prepares the ListQueryResultsForManagementGroup request.

func (PolicyEventsClient) ListQueryResultsForManagementGroupResponder 

func (client PolicyEventsClient) ListQueryResultsForManagementGroupResponder(resp *http.Response) (result PolicyEventsQueryResults, err error)

ListQueryResultsForManagementGroupResponder handles the response to the ListQueryResultsForManagementGroup request. The method always closes the http.Response Body.

func (PolicyEventsClient) ListQueryResultsForManagementGroupSender 

func (client PolicyEventsClient) ListQueryResultsForManagementGroupSender(req *http.Request) (*http.Response, error)

ListQueryResultsForManagementGroupSender sends the ListQueryResultsForManagementGroup request. The method will close the http.Response Body if it receives an error.

func (PolicyEventsClient) ListQueryResultsForResource 

func (client PolicyEventsClient) ListQueryResultsForResource(ctx context.Context, resourceID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyEventsQueryResults, err error)

ListQueryResultsForResource queries policy events for the resource.

resourceID is resource ID. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyEventsClient) ListQueryResultsForResourceGroup 

func (client PolicyEventsClient) ListQueryResultsForResourceGroup(ctx context.Context, subscriptionID string, resourceGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyEventsQueryResults, err error)

ListQueryResultsForResourceGroup queries policy events for the resources under the resource group.

subscriptionID is microsoft Azure subscription ID. resourceGroupName is resource group name. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyEventsClient) ListQueryResultsForResourceGroupPreparer 

func (client PolicyEventsClient) ListQueryResultsForResourceGroupPreparer(ctx context.Context, subscriptionID string, resourceGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForResourceGroupPreparer prepares the ListQueryResultsForResourceGroup request.

func (PolicyEventsClient) ListQueryResultsForResourceGroupResponder 

func (client PolicyEventsClient) ListQueryResultsForResourceGroupResponder(resp *http.Response) (result PolicyEventsQueryResults, err error)

ListQueryResultsForResourceGroupResponder handles the response to the ListQueryResultsForResourceGroup request. The method always closes the http.Response Body.

func (PolicyEventsClient) ListQueryResultsForResourceGroupSender 

func (client PolicyEventsClient) ListQueryResultsForResourceGroupSender(req *http.Request) (*http.Response, error)

ListQueryResultsForResourceGroupSender sends the ListQueryResultsForResourceGroup request. The method will close the http.Response Body if it receives an error.

func (PolicyEventsClient) ListQueryResultsForResourcePreparer 

func (client PolicyEventsClient) ListQueryResultsForResourcePreparer(ctx context.Context, resourceID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForResourcePreparer prepares the ListQueryResultsForResource request.

func (PolicyEventsClient) ListQueryResultsForResourceResponder 

func (client PolicyEventsClient) ListQueryResultsForResourceResponder(resp *http.Response) (result PolicyEventsQueryResults, err error)

ListQueryResultsForResourceResponder handles the response to the ListQueryResultsForResource request. The method always closes the http.Response Body.

func (PolicyEventsClient) ListQueryResultsForResourceSender 

func (client PolicyEventsClient) ListQueryResultsForResourceSender(req *http.Request) (*http.Response, error)

ListQueryResultsForResourceSender sends the ListQueryResultsForResource request. The method will close the http.Response Body if it receives an error.

func (PolicyEventsClient) ListQueryResultsForSubscription 

func (client PolicyEventsClient) ListQueryResultsForSubscription(ctx context.Context, subscriptionID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyEventsQueryResults, err error)

ListQueryResultsForSubscription queries policy events for the resources under the subscription.

subscriptionID is microsoft Azure subscription ID. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyEventsClient) ListQueryResultsForSubscriptionPreparer 

func (client PolicyEventsClient) ListQueryResultsForSubscriptionPreparer(ctx context.Context, subscriptionID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForSubscriptionPreparer prepares the ListQueryResultsForSubscription request.

func (PolicyEventsClient) ListQueryResultsForSubscriptionResponder 

func (client PolicyEventsClient) ListQueryResultsForSubscriptionResponder(resp *http.Response) (result PolicyEventsQueryResults, err error)

ListQueryResultsForSubscriptionResponder handles the response to the ListQueryResultsForSubscription request. The method always closes the http.Response Body.

func (PolicyEventsClient) ListQueryResultsForSubscriptionSender 

func (client PolicyEventsClient) ListQueryResultsForSubscriptionSender(req *http.Request) (*http.Response, error)

ListQueryResultsForSubscriptionSender sends the ListQueryResultsForSubscription request. The method will close the http.Response Body if it receives an error.

type PolicyEventsQueryResults 

type PolicyEventsQueryResults struct {
	autorest.Response `json:"-"`
	// Value - Query results.
	Value *[]PolicyEventsQueryResultsTable `json:"value,omitempty"`
}

PolicyEventsQueryResults query results.

type PolicyEventsQueryResultsTable 

type PolicyEventsQueryResultsTable struct {
	// Metadata - Metadata about the query results.
	Metadata *PolicyEventsQueryResultsTableMetadata `json:"metadata,omitempty"`
	// Columns - List of columns included in query results.
	Columns *PolicyEventsQueryResultsTableColumns `json:"columns,omitempty"`
	// Rows - Query result rows, each representing a policy event record.
	Rows *[][]interface{} `json:"rows,omitempty"`
}

PolicyEventsQueryResultsTable query results table.

type PolicyEventsQueryResultsTableColumns 

type PolicyEventsQueryResultsTableColumns struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Timestamp - Timestamp for the policy event record.
	Timestamp *Column `json:"Timestamp,omitempty"`
	// ResourceID - Resource ID.
	ResourceID *Column `json:"ResourceId,omitempty"`
	// PolicyAssignmentID - Policy assignment ID.
	PolicyAssignmentID *Column `json:"PolicyAssignmentId,omitempty"`
	// PolicyDefinitionID - Policy definition ID.
	PolicyDefinitionID *Column `json:"PolicyDefinitionId,omitempty"`
	// EffectiveParameters - Effective parameters for the policy assignment.
	EffectiveParameters *Column `json:"EffectiveParameters,omitempty"`
	// IsCompliant - Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
	IsCompliant *Column `json:"IsCompliant,omitempty"`
	// SubscriptionID - Subscription ID.
	SubscriptionID *Column `json:"SubscriptionId,omitempty"`
	// ResourceType - Resource type.
	ResourceType *Column `json:"ResourceType,omitempty"`
	// ResourceLocation - Resource location.
	ResourceLocation *Column `json:"ResourceLocation,omitempty"`
	// ResourceGroup - Resource group name.
	ResourceGroup *Column `json:"ResourceGroup,omitempty"`
	// ResourceTags - List of resource tags.
	ResourceTags *Column `json:"ResourceTags,omitempty"`
	// PolicyAssignmentName - Policy assignment name.
	PolicyAssignmentName *Column `json:"PolicyAssignmentName,omitempty"`
	// PolicyAssignmentOwner - Policy assignment owner.
	PolicyAssignmentOwner *Column `json:"PolicyAssignmentOwner,omitempty"`
	// PolicyAssignmentParameters - Policy assignment parameters.
	PolicyAssignmentParameters *Column `json:"PolicyAssignmentParameters,omitempty"`
	// PolicyAssignmentScope - Policy assignment scope.
	PolicyAssignmentScope *Column `json:"PolicyAssignmentScope,omitempty"`
	// PolicyDefinitionName - Policy definition name.
	PolicyDefinitionName *Column `json:"PolicyDefinitionName,omitempty"`
	// PolicyDefinitionAction - Policy definition action, i.e. effect.
	PolicyDefinitionAction *Column `json:"PolicyDefinitionAction,omitempty"`
	// PolicyDefinitionCategory - Policy definition category.
	PolicyDefinitionCategory *Column `json:"PolicyDefinitionCategory,omitempty"`
	// PolicySetDefinitionID - Policy set definition ID, if the policy assignment is for a policy set.
	PolicySetDefinitionID *Column `json:"PolicySetDefinitionId,omitempty"`
	// PolicySetDefinitionName - Policy set definition name, if the policy assignment is for a policy set.
	PolicySetDefinitionName *Column `json:"PolicySetDefinitionName,omitempty"`
	// PolicySetDefinitionOwner - Policy set definition owner, if the policy assignment is for a policy set.
	PolicySetDefinitionOwner *Column `json:"PolicySetDefinitionOwner,omitempty"`
	// PolicySetDefinitionCategory - Policy set definition category, if the policy assignment is for a policy set.
	PolicySetDefinitionCategory *Column `json:"PolicySetDefinitionCategory,omitempty"`
	// PolicySetDefinitionParameters - Policy set definition parameters, if the policy assignment is for a policy set.
	PolicySetDefinitionParameters *Column `json:"PolicySetDefinitionParameters,omitempty"`
	// ManagementGroupIds - Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
	ManagementGroupIds *Column `json:"ManagementGroupIds,omitempty"`
	// PolicyDefinitionReferenceID - Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
	PolicyDefinitionReferenceID *Column `json:"PolicyDefinitionReferenceId,omitempty"`
	// TenantID - Tenant ID for the policy event record.
	TenantID *Column `json:"TenantId,omitempty"`
	// PrincipalOid - Principal object ID for the user who initiated the resource operation that triggered the policy event.
	PrincipalOid *Column `json:"PrincipalOid,omitempty"`
}

PolicyEventsQueryResultsTableColumns list of columns included in query results.

func (PolicyEventsQueryResultsTableColumns) MarshalJSON 

func (peqrt PolicyEventsQueryResultsTableColumns) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PolicyEventsQueryResultsTableColumns.

type PolicyEventsQueryResultsTableMetadata 

type PolicyEventsQueryResultsTableMetadata struct {
	// GeneratedQuery - Internal query generated. Used for diagnostics purposes.
	GeneratedQuery *string `json:"generatedQuery,omitempty"`
}

PolicyEventsQueryResultsTableMetadata metadata about the query results.

type PolicyStatesClient 

type PolicyStatesClient struct {
	BaseClient
}

PolicyStatesClient is the client for the PolicyStates methods of the Policyinsights service.

func NewPolicyStatesClient 

func NewPolicyStatesClient() PolicyStatesClient

NewPolicyStatesClient creates an instance of the PolicyStatesClient client.

func NewPolicyStatesClientWithBaseURI 

func NewPolicyStatesClientWithBaseURI(baseURI string) PolicyStatesClient

NewPolicyStatesClientWithBaseURI creates an instance of the PolicyStatesClient client.

func (PolicyStatesClient) ListQueryResultsForManagementGroup 

func (client PolicyStatesClient) ListQueryResultsForManagementGroup(ctx context.Context, policyStatesResource PolicyStatesResource, managementGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyStatesQueryResults, err error)

ListQueryResultsForManagementGroup queries policy states for the resources under the management group.

policyStatesResource is the virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). managementGroupName is management group name. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyStatesClient) ListQueryResultsForManagementGroupPreparer 

func (client PolicyStatesClient) ListQueryResultsForManagementGroupPreparer(ctx context.Context, policyStatesResource PolicyStatesResource, managementGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForManagementGroupPreparer prepares the ListQueryResultsForManagementGroup request.

func (PolicyStatesClient) ListQueryResultsForManagementGroupResponder 

func (client PolicyStatesClient) ListQueryResultsForManagementGroupResponder(resp *http.Response) (result PolicyStatesQueryResults, err error)

ListQueryResultsForManagementGroupResponder handles the response to the ListQueryResultsForManagementGroup request. The method always closes the http.Response Body.

func (PolicyStatesClient) ListQueryResultsForManagementGroupSender 

func (client PolicyStatesClient) ListQueryResultsForManagementGroupSender(req *http.Request) (*http.Response, error)

ListQueryResultsForManagementGroupSender sends the ListQueryResultsForManagementGroup request. The method will close the http.Response Body if it receives an error.

func (PolicyStatesClient) ListQueryResultsForResource 

func (client PolicyStatesClient) ListQueryResultsForResource(ctx context.Context, policyStatesResource PolicyStatesResource, resourceID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyStatesQueryResults, err error)

ListQueryResultsForResource queries policy states for the resource.

policyStatesResource is the virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). resourceID is resource ID. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyStatesClient) ListQueryResultsForResourceGroup 

func (client PolicyStatesClient) ListQueryResultsForResourceGroup(ctx context.Context, policyStatesResource PolicyStatesResource, subscriptionID string, resourceGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyStatesQueryResults, err error)

ListQueryResultsForResourceGroup queries policy states for the resources under the resource group.

policyStatesResource is the virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). subscriptionID is microsoft Azure subscription ID. resourceGroupName is resource group name. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyStatesClient) ListQueryResultsForResourceGroupPreparer 

func (client PolicyStatesClient) ListQueryResultsForResourceGroupPreparer(ctx context.Context, policyStatesResource PolicyStatesResource, subscriptionID string, resourceGroupName string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForResourceGroupPreparer prepares the ListQueryResultsForResourceGroup request.

func (PolicyStatesClient) ListQueryResultsForResourceGroupResponder 

func (client PolicyStatesClient) ListQueryResultsForResourceGroupResponder(resp *http.Response) (result PolicyStatesQueryResults, err error)

ListQueryResultsForResourceGroupResponder handles the response to the ListQueryResultsForResourceGroup request. The method always closes the http.Response Body.

func (PolicyStatesClient) ListQueryResultsForResourceGroupSender 

func (client PolicyStatesClient) ListQueryResultsForResourceGroupSender(req *http.Request) (*http.Response, error)

ListQueryResultsForResourceGroupSender sends the ListQueryResultsForResourceGroup request. The method will close the http.Response Body if it receives an error.

func (PolicyStatesClient) ListQueryResultsForResourcePreparer 

func (client PolicyStatesClient) ListQueryResultsForResourcePreparer(ctx context.Context, policyStatesResource PolicyStatesResource, resourceID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForResourcePreparer prepares the ListQueryResultsForResource request.

func (PolicyStatesClient) ListQueryResultsForResourceResponder 

func (client PolicyStatesClient) ListQueryResultsForResourceResponder(resp *http.Response) (result PolicyStatesQueryResults, err error)

ListQueryResultsForResourceResponder handles the response to the ListQueryResultsForResource request. The method always closes the http.Response Body.

func (PolicyStatesClient) ListQueryResultsForResourceSender 

func (client PolicyStatesClient) ListQueryResultsForResourceSender(req *http.Request) (*http.Response, error)

ListQueryResultsForResourceSender sends the ListQueryResultsForResource request. The method will close the http.Response Body if it receives an error.

func (PolicyStatesClient) ListQueryResultsForSubscription 

func (client PolicyStatesClient) ListQueryResultsForSubscription(ctx context.Context, policyStatesResource PolicyStatesResource, subscriptionID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (result PolicyStatesQueryResults, err error)

ListQueryResultsForSubscription queries policy states for the resources under the subscription.

policyStatesResource is the virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). subscriptionID is microsoft Azure subscription ID. top is maximum number of records to return. orderBy is ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". selectParameter is select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". from is ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). toParameter is ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. filter is oData filter expression. apply is oData apply expression for aggregations.

func (PolicyStatesClient) ListQueryResultsForSubscriptionPreparer 

func (client PolicyStatesClient) ListQueryResultsForSubscriptionPreparer(ctx context.Context, policyStatesResource PolicyStatesResource, subscriptionID string, top *int32, orderBy string, selectParameter string, from *date.Time, toParameter *date.Time, filter string, apply string) (*http.Request, error)

ListQueryResultsForSubscriptionPreparer prepares the ListQueryResultsForSubscription request.

func (PolicyStatesClient) ListQueryResultsForSubscriptionResponder 

func (client PolicyStatesClient) ListQueryResultsForSubscriptionResponder(resp *http.Response) (result PolicyStatesQueryResults, err error)

ListQueryResultsForSubscriptionResponder handles the response to the ListQueryResultsForSubscription request. The method always closes the http.Response Body.

func (PolicyStatesClient) ListQueryResultsForSubscriptionSender 

func (client PolicyStatesClient) ListQueryResultsForSubscriptionSender(req *http.Request) (*http.Response, error)

ListQueryResultsForSubscriptionSender sends the ListQueryResultsForSubscription request. The method will close the http.Response Body if it receives an error.

type PolicyStatesQueryResults 

type PolicyStatesQueryResults struct {
	autorest.Response `json:"-"`
	// Value - Query results.
	Value *[]PolicyStatesQueryResultsTable `json:"value,omitempty"`
}

PolicyStatesQueryResults query results.

type PolicyStatesQueryResultsTable 

type PolicyStatesQueryResultsTable struct {
	// Metadata - Metadata about the query results.
	Metadata *PolicyStatesQueryResultsTableMetadata `json:"metadata,omitempty"`
	// Columns - List of columns included in query results.
	Columns *PolicyStatesQueryResultsTableColumns `json:"columns,omitempty"`
	// Rows - Query result rows, each representing a policy state record.
	Rows *[][]interface{} `json:"rows,omitempty"`
}

PolicyStatesQueryResultsTable query results table.

type PolicyStatesQueryResultsTableColumns 

type PolicyStatesQueryResultsTableColumns struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Timestamp - Timestamp for the policy state record.
	Timestamp *Column `json:"Timestamp,omitempty"`
	// ResourceID - Resource ID.
	ResourceID *Column `json:"ResourceId,omitempty"`
	// PolicyAssignmentID - Policy assignment ID.
	PolicyAssignmentID *Column `json:"PolicyAssignmentId,omitempty"`
	// PolicyDefinitionID - Policy definition ID.
	PolicyDefinitionID *Column `json:"PolicyDefinitionId,omitempty"`
	// EffectiveParameters - Effective parameters for the policy assignment.
	EffectiveParameters *Column `json:"EffectiveParameters,omitempty"`
	// IsCompliant - Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
	IsCompliant *Column `json:"IsCompliant,omitempty"`
	// SubscriptionID - Subscription ID.
	SubscriptionID *Column `json:"SubscriptionId,omitempty"`
	// ResourceType - Resource type.
	ResourceType *Column `json:"ResourceType,omitempty"`
	// ResourceLocation - Resource location.
	ResourceLocation *Column `json:"ResourceLocation,omitempty"`
	// ResourceGroup - Resource group name.
	ResourceGroup *Column `json:"ResourceGroup,omitempty"`
	// ResourceTags - List of resource tags.
	ResourceTags *Column `json:"ResourceTags,omitempty"`
	// PolicyAssignmentName - Policy assignment name.
	PolicyAssignmentName *Column `json:"PolicyAssignmentName,omitempty"`
	// PolicyAssignmentOwner - Policy assignment owner.
	PolicyAssignmentOwner *Column `json:"PolicyAssignmentOwner,omitempty"`
	// PolicyAssignmentParameters - Policy assignment parameters.
	PolicyAssignmentParameters *Column `json:"PolicyAssignmentParameters,omitempty"`
	// PolicyAssignmentScope - Policy assignment scope.
	PolicyAssignmentScope *Column `json:"PolicyAssignmentScope,omitempty"`
	// PolicyDefinitionName - Policy definition name.
	PolicyDefinitionName *Column `json:"PolicyDefinitionName,omitempty"`
	// PolicyDefinitionAction - Policy definition action, i.e. effect.
	PolicyDefinitionAction *Column `json:"PolicyDefinitionAction,omitempty"`
	// PolicyDefinitionCategory - Policy definition category.
	PolicyDefinitionCategory *Column `json:"PolicyDefinitionCategory,omitempty"`
	// PolicySetDefinitionID - Policy set definition ID, if the policy assignment is for a policy set.
	PolicySetDefinitionID *Column `json:"PolicySetDefinitionId,omitempty"`
	// PolicySetDefinitionName - Policy set definition name, if the policy assignment is for a policy set.
	PolicySetDefinitionName *Column `json:"PolicySetDefinitionName,omitempty"`
	// PolicySetDefinitionOwner - Policy set definition owner, if the policy assignment is for a policy set.
	PolicySetDefinitionOwner *Column `json:"PolicySetDefinitionOwner,omitempty"`
	// PolicySetDefinitionCategory - Policy set definition category, if the policy assignment is for a policy set.
	PolicySetDefinitionCategory *Column `json:"PolicySetDefinitionCategory,omitempty"`
	// PolicySetDefinitionParameters - Policy set definition parameters, if the policy assignment is for a policy set.
	PolicySetDefinitionParameters *Column `json:"PolicySetDefinitionParameters,omitempty"`
	// ManagementGroupIds - Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
	ManagementGroupIds *Column `json:"ManagementGroupIds,omitempty"`
	// PolicyDefinitionReferenceID - Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
	PolicyDefinitionReferenceID *Column `json:"PolicyDefinitionReferenceId,omitempty"`
}

PolicyStatesQueryResultsTableColumns list of columns included in query results.

func (PolicyStatesQueryResultsTableColumns) MarshalJSON 

func (psqrt PolicyStatesQueryResultsTableColumns) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PolicyStatesQueryResultsTableColumns.

type PolicyStatesQueryResultsTableMetadata 

type PolicyStatesQueryResultsTableMetadata struct {
	// GeneratedQuery - Internal query generated. Used for diagnostics purposes.
	GeneratedQuery *string `json:"generatedQuery,omitempty"`
}

PolicyStatesQueryResultsTableMetadata metadata about the query results.

type PolicyStatesResource 

type PolicyStatesResource string

PolicyStatesResource enumerates the values for policy states resource. 

const (
	// Default ...
	Default PolicyStatesResource = "default"
	// Latest ...
	Latest PolicyStatesResource = "latest"
)

func PossiblePolicyStatesResourceValues 

func PossiblePolicyStatesResourceValues() []PolicyStatesResource

PossiblePolicyStatesResourceValues returns an array of possible values for the PolicyStatesResource const type.

type QueryFailure 

type QueryFailure struct {
	// Error - Error definition.
	Error *QueryFailureError `json:"error,omitempty"`
}

QueryFailure error response.

type QueryFailureError 

type QueryFailureError struct {
	// Code - Service specific error code which serves as the substatus for the HTTP error code.
	Code *string `json:"code,omitempty"`
	// Message - Description of the error.
	Message *string `json:"message,omitempty"`
}

QueryFailureError error definition.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.