iam_tf

package
v1.55.0 Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControlRequest 

type AccessControlRequest struct {
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
	// application ID of a service principal
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*AccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan AccessControlRequest)

func (*AccessControlRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AccessControlRequest) SyncEffectiveFieldsDuringRead(existingState AccessControlRequest)

type AccessControlResponse 

type AccessControlResponse struct {
	// All permissions.
	AllPermissions []Permission `tfsdk:"all_permissions" tf:"optional"`
	// Display name of the user or service principal.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Name of the service principal.
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*AccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan AccessControlResponse)

func (*AccessControlResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AccessControlResponse) SyncEffectiveFieldsDuringRead(existingState AccessControlResponse)

type ComplexValue 

type ComplexValue struct {
	Display types.String `tfsdk:"display" tf:"optional"`

	Primary types.Bool `tfsdk:"primary" tf:"optional"`

	Ref types.String `tfsdk:"$ref" tf:"optional"`

	Type types.String `tfsdk:"type" tf:"optional"`

	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*ComplexValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ComplexValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan ComplexValue)

func (*ComplexValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ComplexValue) SyncEffectiveFieldsDuringRead(existingState ComplexValue)

type DeleteAccountGroupRequest 

type DeleteAccountGroupRequest struct {
	// Unique ID for a group in the Databricks account.
	Id types.String `tfsdk:"-"`
}

Delete a group

func (*DeleteAccountGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteAccountGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteAccountGroupRequest)

func (*DeleteAccountGroupRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteAccountGroupRequest) SyncEffectiveFieldsDuringRead(existingState DeleteAccountGroupRequest)

type DeleteAccountServicePrincipalRequest 

type DeleteAccountServicePrincipalRequest struct {
	// Unique ID for a service principal in the Databricks account.
	Id types.String `tfsdk:"-"`
}

Delete a service principal

func (*DeleteAccountServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteAccountServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteAccountServicePrincipalRequest)

func (*DeleteAccountServicePrincipalRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteAccountServicePrincipalRequest) SyncEffectiveFieldsDuringRead(existingState DeleteAccountServicePrincipalRequest)

type DeleteAccountUserRequest 

type DeleteAccountUserRequest struct {
	// Unique ID for a user in the Databricks account.
	Id types.String `tfsdk:"-"`
}

Delete a user

func (*DeleteAccountUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteAccountUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteAccountUserRequest)

func (*DeleteAccountUserRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteAccountUserRequest) SyncEffectiveFieldsDuringRead(existingState DeleteAccountUserRequest)

type DeleteGroupRequest 

type DeleteGroupRequest struct {
	// Unique ID for a group in the Databricks workspace.
	Id types.String `tfsdk:"-"`
}

Delete a group

func (*DeleteGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteGroupRequest)

func (*DeleteGroupRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteGroupRequest) SyncEffectiveFieldsDuringRead(existingState DeleteGroupRequest)

type DeleteResponse 

type DeleteResponse struct {
}

func (*DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteResponse)

func (*DeleteResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringRead(existingState DeleteResponse)

type DeleteServicePrincipalRequest 

type DeleteServicePrincipalRequest struct {
	// Unique ID for a service principal in the Databricks workspace.
	Id types.String `tfsdk:"-"`
}

Delete a service principal

func (*DeleteServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteServicePrincipalRequest)

func (*DeleteServicePrincipalRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteServicePrincipalRequest) SyncEffectiveFieldsDuringRead(existingState DeleteServicePrincipalRequest)

type DeleteUserRequest 

type DeleteUserRequest struct {
	// Unique ID for a user in the Databricks workspace.
	Id types.String `tfsdk:"-"`
}

Delete a user

func (*DeleteUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteUserRequest)

func (*DeleteUserRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteUserRequest) SyncEffectiveFieldsDuringRead(existingState DeleteUserRequest)

type DeleteWorkspaceAssignmentRequest 

type DeleteWorkspaceAssignmentRequest struct {
	// The ID of the user, service principal, or group.
	PrincipalId types.Int64 `tfsdk:"-"`
	// The workspace ID for the account.
	WorkspaceId types.Int64 `tfsdk:"-"`
}

Delete permissions assignment

func (*DeleteWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteWorkspaceAssignmentRequest)

func (*DeleteWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead(existingState DeleteWorkspaceAssignmentRequest)

type DeleteWorkspacePermissionAssignmentResponse 

type DeleteWorkspacePermissionAssignmentResponse struct {
}

func (*DeleteWorkspacePermissionAssignmentResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteWorkspacePermissionAssignmentResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteWorkspacePermissionAssignmentResponse)

func (*DeleteWorkspacePermissionAssignmentResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteWorkspacePermissionAssignmentResponse) SyncEffectiveFieldsDuringRead(existingState DeleteWorkspacePermissionAssignmentResponse)

type GetAccountGroupRequest 

type GetAccountGroupRequest struct {
	// Unique ID for a group in the Databricks account.
	Id types.String `tfsdk:"-"`
}

Get group details

func (*GetAccountGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAccountGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAccountGroupRequest)

func (*GetAccountGroupRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAccountGroupRequest) SyncEffectiveFieldsDuringRead(existingState GetAccountGroupRequest)

type GetAccountServicePrincipalRequest 

type GetAccountServicePrincipalRequest struct {
	// Unique ID for a service principal in the Databricks account.
	Id types.String `tfsdk:"-"`
}

Get service principal details

func (*GetAccountServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAccountServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAccountServicePrincipalRequest)

func (*GetAccountServicePrincipalRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAccountServicePrincipalRequest) SyncEffectiveFieldsDuringRead(existingState GetAccountServicePrincipalRequest)

type GetAccountUserRequest 

type GetAccountUserRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page. Default is 10000.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Unique ID for a user in the Databricks account.
	Id types.String `tfsdk:"-"`
	// Attribute to sort the results. Multi-part paths are supported. For
	// example, `userName`, `name.givenName`, and `emails`.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

Get user details

func (*GetAccountUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAccountUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAccountUserRequest)

func (*GetAccountUserRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAccountUserRequest) SyncEffectiveFieldsDuringRead(existingState GetAccountUserRequest)

type GetAssignableRolesForResourceRequest 

type GetAssignableRolesForResourceRequest struct {
	// The resource name for which assignable roles will be listed.
	Resource types.String `tfsdk:"-"`
}

Get assignable roles for a resource

func (*GetAssignableRolesForResourceRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAssignableRolesForResourceRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAssignableRolesForResourceRequest)

func (*GetAssignableRolesForResourceRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAssignableRolesForResourceRequest) SyncEffectiveFieldsDuringRead(existingState GetAssignableRolesForResourceRequest)

type GetAssignableRolesForResourceResponse 

type GetAssignableRolesForResourceResponse struct {
	Roles []Role `tfsdk:"roles" tf:"optional"`
}

func (*GetAssignableRolesForResourceResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAssignableRolesForResourceResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAssignableRolesForResourceResponse)

func (*GetAssignableRolesForResourceResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAssignableRolesForResourceResponse) SyncEffectiveFieldsDuringRead(existingState GetAssignableRolesForResourceResponse)

type GetGroupRequest 

type GetGroupRequest struct {
	// Unique ID for a group in the Databricks workspace.
	Id types.String `tfsdk:"-"`
}

Get group details

func (*GetGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetGroupRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetGroupRequest)

func (*GetGroupRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetGroupRequest) SyncEffectiveFieldsDuringRead(existingState GetGroupRequest)

type GetPasswordPermissionLevelsResponse 

type GetPasswordPermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []PasswordPermissionsDescription `tfsdk:"permission_levels" tf:"optional"`
}

func (*GetPasswordPermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetPasswordPermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetPasswordPermissionLevelsResponse)

func (*GetPasswordPermissionLevelsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetPasswordPermissionLevelsResponse) SyncEffectiveFieldsDuringRead(existingState GetPasswordPermissionLevelsResponse)

type GetPermissionLevelsRequest 

type GetPermissionLevelsRequest struct {
	// <needs content>
	RequestObjectId types.String `tfsdk:"-"`
	// <needs content>
	RequestObjectType types.String `tfsdk:"-"`
}

Get object permission levels

func (*GetPermissionLevelsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetPermissionLevelsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetPermissionLevelsRequest)

func (*GetPermissionLevelsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetPermissionLevelsRequest) SyncEffectiveFieldsDuringRead(existingState GetPermissionLevelsRequest)

type GetPermissionLevelsResponse 

type GetPermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []PermissionsDescription `tfsdk:"permission_levels" tf:"optional"`
}

func (*GetPermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetPermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetPermissionLevelsResponse)

func (*GetPermissionLevelsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetPermissionLevelsResponse) SyncEffectiveFieldsDuringRead(existingState GetPermissionLevelsResponse)

type GetPermissionRequest 

type GetPermissionRequest struct {
	// The id of the request object.
	RequestObjectId types.String `tfsdk:"-"`
	// The type of the request object. Can be one of the following: alerts,
	// authorization, clusters, cluster-policies, dashboards, dbsql-dashboards,
	// directories, experiments, files, instance-pools, jobs, notebooks,
	// pipelines, queries, registered-models, repos, serving-endpoints, or
	// warehouses.
	RequestObjectType types.String `tfsdk:"-"`
}

Get object permissions

func (*GetPermissionRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetPermissionRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetPermissionRequest)

func (*GetPermissionRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetPermissionRequest) SyncEffectiveFieldsDuringRead(existingState GetPermissionRequest)

type GetRuleSetRequest 

type GetRuleSetRequest struct {
	// Etag used for versioning. The response is at least as fresh as the eTag
	// provided. Etag is used for optimistic concurrency control as a way to
	// help prevent simultaneous updates of a rule set from overwriting each
	// other. It is strongly suggested that systems make use of the etag in the
	// read -> modify -> write pattern to perform rule set updates in order to
	// avoid race conditions that is get an etag from a GET rule set request,
	// and pass it with the PUT update request to identify the rule set version
	// you are updating.
	Etag types.String `tfsdk:"-"`
	// The ruleset name associated with the request.
	Name types.String `tfsdk:"-"`
}

Get a rule set

func (*GetRuleSetRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetRuleSetRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetRuleSetRequest)

func (*GetRuleSetRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetRuleSetRequest) SyncEffectiveFieldsDuringRead(existingState GetRuleSetRequest)

type GetServicePrincipalRequest 

type GetServicePrincipalRequest struct {
	// Unique ID for a service principal in the Databricks workspace.
	Id types.String `tfsdk:"-"`
}

Get service principal details

func (*GetServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetServicePrincipalRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetServicePrincipalRequest)

func (*GetServicePrincipalRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetServicePrincipalRequest) SyncEffectiveFieldsDuringRead(existingState GetServicePrincipalRequest)

type GetUserRequest 

type GetUserRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Unique ID for a user in the Databricks workspace.
	Id types.String `tfsdk:"-"`
	// Attribute to sort the results. Multi-part paths are supported. For
	// example, `userName`, `name.givenName`, and `emails`.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

Get user details

func (*GetUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetUserRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetUserRequest)

func (*GetUserRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetUserRequest) SyncEffectiveFieldsDuringRead(existingState GetUserRequest)

type GetWorkspaceAssignmentRequest 

type GetWorkspaceAssignmentRequest struct {
	// The workspace ID.
	WorkspaceId types.Int64 `tfsdk:"-"`
}

List workspace permissions

func (*GetWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWorkspaceAssignmentRequest)

func (*GetWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead(existingState GetWorkspaceAssignmentRequest)

type GrantRule 

type GrantRule struct {
	// Principals this grant rule applies to.
	Principals []types.String `tfsdk:"principals" tf:"optional"`
	// Role that is assigned to the list of principals.
	Role types.String `tfsdk:"role" tf:""`
}

func (*GrantRule) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GrantRule) SyncEffectiveFieldsDuringCreateOrUpdate(plan GrantRule)

func (*GrantRule) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GrantRule) SyncEffectiveFieldsDuringRead(existingState GrantRule)

type Group 

type Group struct {
	// String that represents a human-readable group name
	DisplayName types.String `tfsdk:"displayName" tf:"optional"`
	// Entitlements assigned to the group. See [assigning entitlements] for a
	// full list of supported values.
	//
	// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
	Entitlements []ComplexValue `tfsdk:"entitlements" tf:"optional"`

	ExternalId types.String `tfsdk:"externalId" tf:"optional"`

	Groups []ComplexValue `tfsdk:"groups" tf:"optional"`
	// Databricks group ID
	Id types.String `tfsdk:"id" tf:"optional"`

	Members []ComplexValue `tfsdk:"members" tf:"optional"`
	// Container for the group identifier. Workspace local versus account.
	Meta []ResourceMeta `tfsdk:"meta" tf:"optional,object"`
	// Corresponds to AWS instance profile/arn role.
	Roles []ComplexValue `tfsdk:"roles" tf:"optional"`
	// The schema of the group.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
}

func (*Group) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Group) SyncEffectiveFieldsDuringCreateOrUpdate(plan Group)

func (*Group) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Group) SyncEffectiveFieldsDuringRead(existingState Group)

type ListAccountGroupsRequest 

type ListAccountGroupsRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page. Default is 10000.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List group details

func (*ListAccountGroupsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAccountGroupsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAccountGroupsRequest)

func (*ListAccountGroupsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAccountGroupsRequest) SyncEffectiveFieldsDuringRead(existingState ListAccountGroupsRequest)

type ListAccountServicePrincipalsRequest 

type ListAccountServicePrincipalsRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page. Default is 10000.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List service principals

func (*ListAccountServicePrincipalsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAccountServicePrincipalsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAccountServicePrincipalsRequest)

func (*ListAccountServicePrincipalsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAccountServicePrincipalsRequest) SyncEffectiveFieldsDuringRead(existingState ListAccountServicePrincipalsRequest)

type ListAccountUsersRequest 

type ListAccountUsersRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page. Default is 10000.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results. Multi-part paths are supported. For
	// example, `userName`, `name.givenName`, and `emails`.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List users

func (*ListAccountUsersRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAccountUsersRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAccountUsersRequest)

func (*ListAccountUsersRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAccountUsersRequest) SyncEffectiveFieldsDuringRead(existingState ListAccountUsersRequest)

type ListGroupsRequest 

type ListGroupsRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List group details

func (*ListGroupsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListGroupsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListGroupsRequest)

func (*ListGroupsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListGroupsRequest) SyncEffectiveFieldsDuringRead(existingState ListGroupsRequest)

type ListGroupsResponse 

type ListGroupsResponse struct {
	// Total results returned in the response.
	ItemsPerPage types.Int64 `tfsdk:"itemsPerPage" tf:"optional"`
	// User objects returned in the response.
	Resources []Group `tfsdk:"Resources" tf:"optional"`
	// The schema of the service principal.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
	// Starting index of all the results that matched the request filters. First
	// item is number 1.
	StartIndex types.Int64 `tfsdk:"startIndex" tf:"optional"`
	// Total results that match the request filters.
	TotalResults types.Int64 `tfsdk:"totalResults" tf:"optional"`
}

func (*ListGroupsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListGroupsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListGroupsResponse)

func (*ListGroupsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListGroupsResponse) SyncEffectiveFieldsDuringRead(existingState ListGroupsResponse)

type ListServicePrincipalResponse 

type ListServicePrincipalResponse struct {
	// Total results returned in the response.
	ItemsPerPage types.Int64 `tfsdk:"itemsPerPage" tf:"optional"`
	// User objects returned in the response.
	Resources []ServicePrincipal `tfsdk:"Resources" tf:"optional"`
	// The schema of the List response.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
	// Starting index of all the results that matched the request filters. First
	// item is number 1.
	StartIndex types.Int64 `tfsdk:"startIndex" tf:"optional"`
	// Total results that match the request filters.
	TotalResults types.Int64 `tfsdk:"totalResults" tf:"optional"`
}

func (*ListServicePrincipalResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListServicePrincipalResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListServicePrincipalResponse)

func (*ListServicePrincipalResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListServicePrincipalResponse) SyncEffectiveFieldsDuringRead(existingState ListServicePrincipalResponse)

type ListServicePrincipalsRequest 

type ListServicePrincipalsRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List service principals

func (*ListServicePrincipalsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListServicePrincipalsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListServicePrincipalsRequest)

func (*ListServicePrincipalsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListServicePrincipalsRequest) SyncEffectiveFieldsDuringRead(existingState ListServicePrincipalsRequest)

type ListUsersRequest 

type ListUsersRequest struct {
	// Comma-separated list of attributes to return in response.
	Attributes types.String `tfsdk:"-"`
	// Desired number of results per page.
	Count types.Int64 `tfsdk:"-"`
	// Comma-separated list of attributes to exclude in response.
	ExcludedAttributes types.String `tfsdk:"-"`
	// Query by which the results have to be filtered. Supported operators are
	// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
	// Additionally, simple expressions can be formed using logical operators -
	// `and` and `or`. The [SCIM RFC] has more details but we currently only
	// support simple expressions.
	//
	// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
	Filter types.String `tfsdk:"-"`
	// Attribute to sort the results. Multi-part paths are supported. For
	// example, `userName`, `name.givenName`, and `emails`.
	SortBy types.String `tfsdk:"-"`
	// The order to sort the results.
	SortOrder types.String `tfsdk:"-"`
	// Specifies the index of the first result. First item is number 1.
	StartIndex types.Int64 `tfsdk:"-"`
}

List users

func (*ListUsersRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListUsersRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListUsersRequest)

func (*ListUsersRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListUsersRequest) SyncEffectiveFieldsDuringRead(existingState ListUsersRequest)

type ListUsersResponse 

type ListUsersResponse struct {
	// Total results returned in the response.
	ItemsPerPage types.Int64 `tfsdk:"itemsPerPage" tf:"optional"`
	// User objects returned in the response.
	Resources []User `tfsdk:"Resources" tf:"optional"`
	// The schema of the List response.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
	// Starting index of all the results that matched the request filters. First
	// item is number 1.
	StartIndex types.Int64 `tfsdk:"startIndex" tf:"optional"`
	// Total results that match the request filters.
	TotalResults types.Int64 `tfsdk:"totalResults" tf:"optional"`
}

func (*ListUsersResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListUsersResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListUsersResponse)

func (*ListUsersResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListUsersResponse) SyncEffectiveFieldsDuringRead(existingState ListUsersResponse)

type ListWorkspaceAssignmentRequest 

type ListWorkspaceAssignmentRequest struct {
	// The workspace ID for the account.
	WorkspaceId types.Int64 `tfsdk:"-"`
}

Get permission assignments

func (*ListWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListWorkspaceAssignmentRequest)

func (*ListWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListWorkspaceAssignmentRequest) SyncEffectiveFieldsDuringRead(existingState ListWorkspaceAssignmentRequest)

type MigratePermissionsRequest 

type MigratePermissionsRequest struct {
	// The name of the workspace group that permissions will be migrated from.
	FromWorkspaceGroupName types.String `tfsdk:"from_workspace_group_name" tf:""`
	// The maximum number of permissions that will be migrated.
	Size types.Int64 `tfsdk:"size" tf:"optional"`
	// The name of the account group that permissions will be migrated to.
	ToAccountGroupName types.String `tfsdk:"to_account_group_name" tf:""`
	// WorkspaceId of the associated workspace where the permission migration
	// will occur.
	WorkspaceId types.Int64 `tfsdk:"workspace_id" tf:""`
}

func (*MigratePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MigratePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan MigratePermissionsRequest)

func (*MigratePermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MigratePermissionsRequest) SyncEffectiveFieldsDuringRead(existingState MigratePermissionsRequest)

type MigratePermissionsResponse 

type MigratePermissionsResponse struct {
	// Number of permissions migrated.
	PermissionsMigrated types.Int64 `tfsdk:"permissions_migrated" tf:"optional"`
}

func (*MigratePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MigratePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan MigratePermissionsResponse)

func (*MigratePermissionsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MigratePermissionsResponse) SyncEffectiveFieldsDuringRead(existingState MigratePermissionsResponse)

type Name 

type Name struct {
	// Family name of the Databricks user.
	FamilyName types.String `tfsdk:"familyName" tf:"optional"`
	// Given name of the Databricks user.
	GivenName types.String `tfsdk:"givenName" tf:"optional"`
}

func (*Name) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Name) SyncEffectiveFieldsDuringCreateOrUpdate(plan Name)

func (*Name) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Name) SyncEffectiveFieldsDuringRead(existingState Name)

type ObjectPermissions 

type ObjectPermissions struct {
	AccessControlList []AccessControlResponse `tfsdk:"access_control_list" tf:"optional"`

	ObjectId types.String `tfsdk:"object_id" tf:"optional"`

	ObjectType types.String `tfsdk:"object_type" tf:"optional"`
}

func (*ObjectPermissions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ObjectPermissions) SyncEffectiveFieldsDuringCreateOrUpdate(plan ObjectPermissions)

func (*ObjectPermissions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ObjectPermissions) SyncEffectiveFieldsDuringRead(existingState ObjectPermissions)

type PartialUpdate 

type PartialUpdate struct {
	// Unique ID for a user in the Databricks workspace.
	Id types.String `tfsdk:"-"`

	Operations []Patch `tfsdk:"Operations" tf:"optional"`
	// The schema of the patch request. Must be
	// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
}

func (*PartialUpdate) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PartialUpdate) SyncEffectiveFieldsDuringCreateOrUpdate(plan PartialUpdate)

func (*PartialUpdate) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PartialUpdate) SyncEffectiveFieldsDuringRead(existingState PartialUpdate)

type PasswordAccessControlRequest 

type PasswordAccessControlRequest struct {
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
	// application ID of a service principal
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*PasswordAccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordAccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordAccessControlRequest)

func (*PasswordAccessControlRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordAccessControlRequest) SyncEffectiveFieldsDuringRead(existingState PasswordAccessControlRequest)

type PasswordAccessControlResponse 

type PasswordAccessControlResponse struct {
	// All permissions.
	AllPermissions []PasswordPermission `tfsdk:"all_permissions" tf:"optional"`
	// Display name of the user or service principal.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Name of the service principal.
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*PasswordAccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordAccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordAccessControlResponse)

func (*PasswordAccessControlResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordAccessControlResponse) SyncEffectiveFieldsDuringRead(existingState PasswordAccessControlResponse)

type PasswordPermission 

type PasswordPermission struct {
	Inherited types.Bool `tfsdk:"inherited" tf:"optional"`

	InheritedFromObject []types.String `tfsdk:"inherited_from_object" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*PasswordPermission) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordPermission) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordPermission)

func (*PasswordPermission) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordPermission) SyncEffectiveFieldsDuringRead(existingState PasswordPermission)

type PasswordPermissions 

type PasswordPermissions struct {
	AccessControlList []PasswordAccessControlResponse `tfsdk:"access_control_list" tf:"optional"`

	ObjectId types.String `tfsdk:"object_id" tf:"optional"`

	ObjectType types.String `tfsdk:"object_type" tf:"optional"`
}

func (*PasswordPermissions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordPermissions) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordPermissions)

func (*PasswordPermissions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordPermissions) SyncEffectiveFieldsDuringRead(existingState PasswordPermissions)

type PasswordPermissionsDescription 

type PasswordPermissionsDescription struct {
	Description types.String `tfsdk:"description" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*PasswordPermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordPermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordPermissionsDescription)

func (*PasswordPermissionsDescription) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordPermissionsDescription) SyncEffectiveFieldsDuringRead(existingState PasswordPermissionsDescription)

type PasswordPermissionsRequest 

type PasswordPermissionsRequest struct {
	AccessControlList []PasswordAccessControlRequest `tfsdk:"access_control_list" tf:"optional"`
}

func (*PasswordPermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PasswordPermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan PasswordPermissionsRequest)

func (*PasswordPermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PasswordPermissionsRequest) SyncEffectiveFieldsDuringRead(existingState PasswordPermissionsRequest)

type Patch 

type Patch struct {
	// Type of patch operation.
	Op types.String `tfsdk:"op" tf:"optional"`
	// Selection of patch operation
	Path types.String `tfsdk:"path" tf:"optional"`
	// Value to modify
	Value any `tfsdk:"value" tf:"optional"`
}

func (*Patch) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Patch) SyncEffectiveFieldsDuringCreateOrUpdate(plan Patch)

func (*Patch) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Patch) SyncEffectiveFieldsDuringRead(existingState Patch)

type PatchResponse 

type PatchResponse struct {
}

func (*PatchResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PatchResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan PatchResponse)

func (*PatchResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PatchResponse) SyncEffectiveFieldsDuringRead(existingState PatchResponse)

type Permission 

type Permission struct {
	Inherited types.Bool `tfsdk:"inherited" tf:"optional"`

	InheritedFromObject []types.String `tfsdk:"inherited_from_object" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*Permission) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Permission) SyncEffectiveFieldsDuringCreateOrUpdate(plan Permission)

func (*Permission) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Permission) SyncEffectiveFieldsDuringRead(existingState Permission)

type PermissionAssignment 

type PermissionAssignment struct {
	// Error response associated with a workspace permission assignment, if any.
	Error types.String `tfsdk:"error" tf:"optional"`
	// The permissions level of the principal.
	Permissions []types.String `tfsdk:"permissions" tf:"optional"`
	// Information about the principal assigned to the workspace.
	Principal []PrincipalOutput `tfsdk:"principal" tf:"optional,object"`
}

The output format for existing workspace PermissionAssignment records, which contains some info for user consumption.

func (*PermissionAssignment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PermissionAssignment) SyncEffectiveFieldsDuringCreateOrUpdate(plan PermissionAssignment)

func (*PermissionAssignment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PermissionAssignment) SyncEffectiveFieldsDuringRead(existingState PermissionAssignment)

type PermissionAssignments 

type PermissionAssignments struct {
	// Array of permissions assignments defined for a workspace.
	PermissionAssignments []PermissionAssignment `tfsdk:"permission_assignments" tf:"optional"`
}

func (*PermissionAssignments) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PermissionAssignments) SyncEffectiveFieldsDuringCreateOrUpdate(plan PermissionAssignments)

func (*PermissionAssignments) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PermissionAssignments) SyncEffectiveFieldsDuringRead(existingState PermissionAssignments)

type PermissionOutput 

type PermissionOutput struct {
	// The results of a permissions query.
	Description types.String `tfsdk:"description" tf:"optional"`

	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*PermissionOutput) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PermissionOutput) SyncEffectiveFieldsDuringCreateOrUpdate(plan PermissionOutput)

func (*PermissionOutput) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PermissionOutput) SyncEffectiveFieldsDuringRead(existingState PermissionOutput)

type PermissionsDescription 

type PermissionsDescription struct {
	Description types.String `tfsdk:"description" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*PermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate(plan PermissionsDescription)

func (*PermissionsDescription) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PermissionsDescription) SyncEffectiveFieldsDuringRead(existingState PermissionsDescription)

type PermissionsRequest 

type PermissionsRequest struct {
	AccessControlList []AccessControlRequest `tfsdk:"access_control_list" tf:"optional"`
	// The id of the request object.
	RequestObjectId types.String `tfsdk:"-"`
	// The type of the request object. Can be one of the following: alerts,
	// authorization, clusters, cluster-policies, dashboards, dbsql-dashboards,
	// directories, experiments, files, instance-pools, jobs, notebooks,
	// pipelines, queries, registered-models, repos, serving-endpoints, or
	// warehouses.
	RequestObjectType types.String `tfsdk:"-"`
}

func (*PermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan PermissionsRequest)

func (*PermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PermissionsRequest) SyncEffectiveFieldsDuringRead(existingState PermissionsRequest)

type PrincipalOutput 

type PrincipalOutput struct {
	// The display name of the principal.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// The group name of the group. Present only if the principal is a group.
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// The unique, opaque id of the principal.
	PrincipalId types.Int64 `tfsdk:"principal_id" tf:"optional"`
	// The name of the service principal. Present only if the principal is a
	// service principal.
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// The username of the user. Present only if the principal is a user.
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

Information about the principal assigned to the workspace.

func (*PrincipalOutput) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PrincipalOutput) SyncEffectiveFieldsDuringCreateOrUpdate(plan PrincipalOutput)

func (*PrincipalOutput) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PrincipalOutput) SyncEffectiveFieldsDuringRead(existingState PrincipalOutput)

type ResourceMeta 

type ResourceMeta struct {
	// Identifier for group type. Can be local workspace group
	// (`WorkspaceGroup`) or account group (`Group`).
	ResourceType types.String `tfsdk:"resourceType" tf:"optional"`
}

func (*ResourceMeta) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ResourceMeta) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResourceMeta)

func (*ResourceMeta) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ResourceMeta) SyncEffectiveFieldsDuringRead(existingState ResourceMeta)

type Role 

type Role struct {
	// Role to assign to a principal or a list of principals on a resource.
	Name types.String `tfsdk:"name" tf:""`
}

func (*Role) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Role) SyncEffectiveFieldsDuringCreateOrUpdate(plan Role)

func (*Role) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Role) SyncEffectiveFieldsDuringRead(existingState Role)

type RuleSetResponse 

type RuleSetResponse struct {
	// Identifies the version of the rule set returned.
	Etag types.String `tfsdk:"etag" tf:"optional"`

	GrantRules []GrantRule `tfsdk:"grant_rules" tf:"optional"`
	// Name of the rule set.
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*RuleSetResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RuleSetResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan RuleSetResponse)

func (*RuleSetResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RuleSetResponse) SyncEffectiveFieldsDuringRead(existingState RuleSetResponse)

type RuleSetUpdateRequest 

type RuleSetUpdateRequest struct {
	// The expected etag of the rule set to update. The update will fail if the
	// value does not match the value that is stored in account access control
	// service.
	Etag types.String `tfsdk:"etag" tf:""`

	GrantRules []GrantRule `tfsdk:"grant_rules" tf:"optional"`
	// Name of the rule set.
	Name types.String `tfsdk:"name" tf:""`
}

func (*RuleSetUpdateRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RuleSetUpdateRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan RuleSetUpdateRequest)

func (*RuleSetUpdateRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RuleSetUpdateRequest) SyncEffectiveFieldsDuringRead(existingState RuleSetUpdateRequest)

type ServicePrincipal 

type ServicePrincipal struct {
	// If this user is active
	Active types.Bool `tfsdk:"active" tf:"optional"`
	// UUID relating to the service principal
	ApplicationId types.String `tfsdk:"applicationId" tf:"optional"`
	// String that represents a concatenation of given and family names.
	DisplayName types.String `tfsdk:"displayName" tf:"optional"`
	// Entitlements assigned to the service principal. See [assigning
	// entitlements] for a full list of supported values.
	//
	// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
	Entitlements []ComplexValue `tfsdk:"entitlements" tf:"optional"`

	ExternalId types.String `tfsdk:"externalId" tf:"optional"`

	Groups []ComplexValue `tfsdk:"groups" tf:"optional"`
	// Databricks service principal ID.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Corresponds to AWS instance profile/arn role.
	Roles []ComplexValue `tfsdk:"roles" tf:"optional"`
	// The schema of the List response.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
}

func (*ServicePrincipal) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ServicePrincipal) SyncEffectiveFieldsDuringCreateOrUpdate(plan ServicePrincipal)

func (*ServicePrincipal) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ServicePrincipal) SyncEffectiveFieldsDuringRead(existingState ServicePrincipal)

type UpdateResponse 

type UpdateResponse struct {
}

func (*UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateResponse)

func (*UpdateResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringRead(existingState UpdateResponse)

type UpdateRuleSetRequest 

type UpdateRuleSetRequest struct {
	// Name of the rule set.
	Name types.String `tfsdk:"name" tf:""`

	RuleSet []RuleSetUpdateRequest `tfsdk:"rule_set" tf:"object"`
}

func (*UpdateRuleSetRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateRuleSetRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateRuleSetRequest)

func (*UpdateRuleSetRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateRuleSetRequest) SyncEffectiveFieldsDuringRead(existingState UpdateRuleSetRequest)

type UpdateWorkspaceAssignments 

type UpdateWorkspaceAssignments struct {
	// Array of permissions assignments to update on the workspace. Valid values
	// are "USER" and "ADMIN" (case-sensitive). If both "USER" and "ADMIN" are
	// provided, "ADMIN" takes precedence. Other values will be ignored. Note
	// that excluding this field, or providing unsupported values, will have the
	// same effect as providing an empty list, which will result in the deletion
	// of all permissions for the principal.
	Permissions []types.String `tfsdk:"permissions" tf:"optional"`
	// The ID of the user, service principal, or group.
	PrincipalId types.Int64 `tfsdk:"-"`
	// The workspace ID for the account.
	WorkspaceId types.Int64 `tfsdk:"-"`
}

func (*UpdateWorkspaceAssignments) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateWorkspaceAssignments) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateWorkspaceAssignments)

func (*UpdateWorkspaceAssignments) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateWorkspaceAssignments) SyncEffectiveFieldsDuringRead(existingState UpdateWorkspaceAssignments)

type User 

type User struct {
	// If this user is active
	Active types.Bool `tfsdk:"active" tf:"optional"`
	// String that represents a concatenation of given and family names. For
	// example `John Smith`. This field cannot be updated through the Workspace
	// SCIM APIs when [identity federation is enabled]. Use Account SCIM APIs to
	// update `displayName`.
	//
	// [identity federation is enabled]: https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation
	DisplayName types.String `tfsdk:"displayName" tf:"optional"`
	// All the emails associated with the Databricks user.
	Emails []ComplexValue `tfsdk:"emails" tf:"optional"`
	// Entitlements assigned to the user. See [assigning entitlements] for a
	// full list of supported values.
	//
	// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
	Entitlements []ComplexValue `tfsdk:"entitlements" tf:"optional"`
	// External ID is not currently supported. It is reserved for future use.
	ExternalId types.String `tfsdk:"externalId" tf:"optional"`

	Groups []ComplexValue `tfsdk:"groups" tf:"optional"`
	// Databricks user ID. This is automatically set by Databricks. Any value
	// provided by the client will be ignored.
	Id types.String `tfsdk:"id" tf:"optional"`

	Name []Name `tfsdk:"name" tf:"optional,object"`
	// Corresponds to AWS instance profile/arn role.
	Roles []ComplexValue `tfsdk:"roles" tf:"optional"`
	// The schema of the user.
	Schemas []types.String `tfsdk:"schemas" tf:"optional"`
	// Email address of the Databricks user.
	UserName types.String `tfsdk:"userName" tf:"optional"`
}

func (*User) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *User) SyncEffectiveFieldsDuringCreateOrUpdate(plan User)

func (*User) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *User) SyncEffectiveFieldsDuringRead(existingState User)

type WorkspacePermissions 

type WorkspacePermissions struct {
	// Array of permissions defined for a workspace.
	Permissions []PermissionOutput `tfsdk:"permissions" tf:"optional"`
}

func (*WorkspacePermissions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WorkspacePermissions) SyncEffectiveFieldsDuringCreateOrUpdate(plan WorkspacePermissions)

func (*WorkspacePermissions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WorkspacePermissions) SyncEffectiveFieldsDuringRead(existingState WorkspacePermissions)

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.