Documentation ¶
Index ¶
- func NewUserTimeoutsOutputReference_Override(u UserTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, ...)
- func NewUser_Override(u User, scope constructs.Construct, id *string, config *UserConfig)
- func User_IsConstruct(x interface{}) *bool
- func User_IsTerraformElement(x interface{}) *bool
- func User_IsTerraformResource(x interface{}) *bool
- func User_TfResourceType() *string
- type User
- type UserConfig
- type UserTimeouts
- type UserTimeoutsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewUserTimeoutsOutputReference_Override ¶
func NewUserTimeoutsOutputReference_Override(u UserTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewUser_Override ¶
func NewUser_Override(u User, scope constructs.Construct, id *string, config *UserConfig)
Create a new {@link https://www.terraform.io/docs/providers/azuread/r/user azuread_user} Resource.
func User_IsConstruct ¶
func User_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func User_TfResourceType ¶
func User_TfResourceType() *string
Types ¶
type User ¶
type User interface { cdktf.TerraformResource AboutMe() *string AccountEnabled() interface{} SetAccountEnabled(val interface{}) AccountEnabledInput() interface{} AgeGroup() *string SetAgeGroup(val *string) AgeGroupInput() *string BusinessPhones() *[]*string SetBusinessPhones(val *[]*string) BusinessPhonesInput() *[]*string // Experimental. CdktfStack() cdktf.TerraformStack City() *string SetCity(val *string) CityInput() *string CompanyName() *string SetCompanyName(val *string) CompanyNameInput() *string // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) ConsentProvidedForMinor() *string SetConsentProvidedForMinor(val *string) ConsentProvidedForMinorInput() *string // Experimental. ConstructNodeMetadata() *map[string]interface{} CostCenter() *string SetCostCenter(val *string) CostCenterInput() *string // Experimental. Count() *float64 // Experimental. SetCount(val *float64) Country() *string SetCountry(val *string) CountryInput() *string CreationType() *string Department() *string SetDepartment(val *string) DepartmentInput() *string // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) DisablePasswordExpiration() interface{} SetDisablePasswordExpiration(val interface{}) DisablePasswordExpirationInput() interface{} DisableStrongPassword() interface{} SetDisableStrongPassword(val interface{}) DisableStrongPasswordInput() interface{} DisplayName() *string SetDisplayName(val *string) DisplayNameInput() *string Division() *string SetDivision(val *string) DivisionInput() *string EmployeeId() *string SetEmployeeId(val *string) EmployeeIdInput() *string EmployeeType() *string SetEmployeeType(val *string) EmployeeTypeInput() *string ExternalUserState() *string FaxNumber() *string SetFaxNumber(val *string) FaxNumberInput() *string ForcePasswordChange() interface{} SetForcePasswordChange(val interface{}) ForcePasswordChangeInput() interface{} // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) // Experimental. Fqn() *string // Experimental. FriendlyUniqueId() *string GivenName() *string SetGivenName(val *string) GivenNameInput() *string Id() *string SetId(val *string) IdInput() *string ImAddresses() *[]*string JobTitle() *string SetJobTitle(val *string) JobTitleInput() *string // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) Mail() *string SetMail(val *string) MailInput() *string MailNickname() *string SetMailNickname(val *string) MailNicknameInput() *string ManagerId() *string SetManagerId(val *string) ManagerIdInput() *string MobilePhone() *string SetMobilePhone(val *string) MobilePhoneInput() *string // The tree node. Node() constructs.Node ObjectId() *string OfficeLocation() *string SetOfficeLocation(val *string) OfficeLocationInput() *string OnpremisesDistinguishedName() *string OnpremisesDomainName() *string OnpremisesImmutableId() *string SetOnpremisesImmutableId(val *string) OnpremisesImmutableIdInput() *string OnpremisesSamAccountName() *string OnpremisesSecurityIdentifier() *string OnpremisesSyncEnabled() cdktf.IResolvable OnpremisesUserPrincipalName() *string OtherMails() *[]*string SetOtherMails(val *[]*string) OtherMailsInput() *[]*string Password() *string SetPassword(val *string) PasswordInput() *string PostalCode() *string SetPostalCode(val *string) PostalCodeInput() *string PreferredLanguage() *string SetPreferredLanguage(val *string) PreferredLanguageInput() *string // Experimental. Provider() cdktf.TerraformProvider // Experimental. SetProvider(val cdktf.TerraformProvider) // Experimental. Provisioners() *[]interface{} // Experimental. SetProvisioners(val *[]interface{}) ProxyAddresses() *[]*string // Experimental. RawOverrides() interface{} ShowInAddressList() interface{} SetShowInAddressList(val interface{}) ShowInAddressListInput() interface{} State() *string SetState(val *string) StateInput() *string StreetAddress() *string SetStreetAddress(val *string) StreetAddressInput() *string Surname() *string SetSurname(val *string) SurnameInput() *string // Experimental. TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata // Experimental. TerraformMetaArguments() *map[string]interface{} // Experimental. TerraformResourceType() *string Timeouts() UserTimeoutsOutputReference TimeoutsInput() interface{} UsageLocation() *string SetUsageLocation(val *string) UsageLocationInput() *string UserPrincipalName() *string SetUserPrincipalName(val *string) UserPrincipalNameInput() *string UserType() *string // Experimental. AddOverride(path *string, value interface{}) // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) PutTimeouts(value *UserTimeouts) ResetAccountEnabled() ResetAgeGroup() ResetBusinessPhones() ResetCity() ResetCompanyName() ResetConsentProvidedForMinor() ResetCostCenter() ResetCountry() ResetDepartment() ResetDisablePasswordExpiration() ResetDisableStrongPassword() ResetDivision() ResetEmployeeId() ResetEmployeeType() ResetFaxNumber() ResetForcePasswordChange() ResetGivenName() ResetId() ResetJobTitle() ResetMail() ResetMailNickname() ResetManagerId() ResetMobilePhone() ResetOfficeLocation() ResetOnpremisesImmutableId() ResetOtherMails() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetPassword() ResetPostalCode() ResetPreferredLanguage() ResetShowInAddressList() ResetState() ResetStreetAddress() ResetSurname() ResetTimeouts() ResetUsageLocation() SynthesizeAttributes() *map[string]interface{} // Experimental. ToMetadata() interface{} // Returns a string representation of this construct. ToString() *string // Adds this resource to the terraform JSON output. // Experimental. ToTerraform() interface{} }
Represents a {@link https://www.terraform.io/docs/providers/azuread/r/user azuread_user}.
func NewUser ¶
func NewUser(scope constructs.Construct, id *string, config *UserConfig) User
Create a new {@link https://www.terraform.io/docs/providers/azuread/r/user azuread_user} Resource.
type UserConfig ¶
type UserConfig struct { // Experimental. Connection interface{} `field:"optional" json:"connection" yaml:"connection"` // Experimental. Count *float64 `field:"optional" json:"count" yaml:"count"` // Experimental. DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"` // Experimental. ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"` // Experimental. Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"` // Experimental. Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"` // Experimental. Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"` // The name to display in the address book for the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#display_name User#display_name} DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The user principal name (UPN) of the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#user_principal_name User#user_principal_name} UserPrincipalName *string `field:"required" json:"userPrincipalName" yaml:"userPrincipalName"` // Whether or not the account should be enabled. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#account_enabled User#account_enabled} AccountEnabled interface{} `field:"optional" json:"accountEnabled" yaml:"accountEnabled"` // The age group of the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#age_group User#age_group} AgeGroup *string `field:"optional" json:"ageGroup" yaml:"ageGroup"` // The telephone numbers for the user. // // Only one number can be set for this property. Read-only for users synced with Azure AD Connect // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#business_phones User#business_phones} BusinessPhones *[]*string `field:"optional" json:"businessPhones" yaml:"businessPhones"` // The city in which the user is located. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#city User#city} City *string `field:"optional" json:"city" yaml:"city"` // The company name which the user is associated. // // This property can be useful for describing the company that an external user comes from // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#company_name User#company_name} CompanyName *string `field:"optional" json:"companyName" yaml:"companyName"` // Whether consent has been obtained for minors. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#consent_provided_for_minor User#consent_provided_for_minor} ConsentProvidedForMinor *string `field:"optional" json:"consentProvidedForMinor" yaml:"consentProvidedForMinor"` // The cost center associated with the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#cost_center User#cost_center} CostCenter *string `field:"optional" json:"costCenter" yaml:"costCenter"` // The country/region in which the user is located, e.g. `US` or `UK`. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#country User#country} Country *string `field:"optional" json:"country" yaml:"country"` // The name for the department in which the user works. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#department User#department} Department *string `field:"optional" json:"department" yaml:"department"` // Whether the users password is exempt from expiring. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#disable_password_expiration User#disable_password_expiration} DisablePasswordExpiration interface{} `field:"optional" json:"disablePasswordExpiration" yaml:"disablePasswordExpiration"` // Whether the user is allowed weaker passwords than the default policy to be specified. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#disable_strong_password User#disable_strong_password} DisableStrongPassword interface{} `field:"optional" json:"disableStrongPassword" yaml:"disableStrongPassword"` // The name of the division in which the user works. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#division User#division} Division *string `field:"optional" json:"division" yaml:"division"` // The employee identifier assigned to the user by the organisation. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#employee_id User#employee_id} EmployeeId *string `field:"optional" json:"employeeId" yaml:"employeeId"` // Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#employee_type User#employee_type} EmployeeType *string `field:"optional" json:"employeeType" yaml:"employeeType"` // The fax number of the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#fax_number User#fax_number} FaxNumber *string `field:"optional" json:"faxNumber" yaml:"faxNumber"` // Whether the user is forced to change the password during the next sign-in. // // Only takes effect when also changing the password // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#force_password_change User#force_password_change} ForcePasswordChange interface{} `field:"optional" json:"forcePasswordChange" yaml:"forcePasswordChange"` // The given name (first name) of the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#given_name User#given_name} GivenName *string `field:"optional" json:"givenName" yaml:"givenName"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#id User#id}. // // Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. // If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable. Id *string `field:"optional" json:"id" yaml:"id"` // The user’s job title. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#job_title User#job_title} JobTitle *string `field:"optional" json:"jobTitle" yaml:"jobTitle"` // The SMTP address for the user. Cannot be unset. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#mail User#mail} Mail *string `field:"optional" json:"mail" yaml:"mail"` // The mail alias for the user. Defaults to the user name part of the user principal name (UPN). // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#mail_nickname User#mail_nickname} MailNickname *string `field:"optional" json:"mailNickname" yaml:"mailNickname"` // The object ID of the user's manager. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#manager_id User#manager_id} ManagerId *string `field:"optional" json:"managerId" yaml:"managerId"` // The primary cellular telephone number for the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#mobile_phone User#mobile_phone} MobilePhone *string `field:"optional" json:"mobilePhone" yaml:"mobilePhone"` // The office location in the user's place of business. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#office_location User#office_location} OfficeLocation *string `field:"optional" json:"officeLocation" yaml:"officeLocation"` // The value used to associate an on-premise Active Directory user account with their Azure AD user object. // // This must be specified if you are using a federated domain for the user's `user_principal_name` property when creating a new user account // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#onpremises_immutable_id User#onpremises_immutable_id} OnpremisesImmutableId *string `field:"optional" json:"onpremisesImmutableId" yaml:"onpremisesImmutableId"` // Additional email addresses for the user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#other_mails User#other_mails} OtherMails *[]*string `field:"optional" json:"otherMails" yaml:"otherMails"` // The password for the user. // // The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#password User#password} Password *string `field:"optional" json:"password" yaml:"password"` // The postal code for the user's postal address. // // The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#postal_code User#postal_code} PostalCode *string `field:"optional" json:"postalCode" yaml:"postalCode"` // The user's preferred language, in ISO 639-1 notation. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#preferred_language User#preferred_language} PreferredLanguage *string `field:"optional" json:"preferredLanguage" yaml:"preferredLanguage"` // Whether or not the Outlook global address list should include this user. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#show_in_address_list User#show_in_address_list} ShowInAddressList interface{} `field:"optional" json:"showInAddressList" yaml:"showInAddressList"` // The state or province in the user's address. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#state User#state} State *string `field:"optional" json:"state" yaml:"state"` // The street address of the user's place of business. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#street_address User#street_address} StreetAddress *string `field:"optional" json:"streetAddress" yaml:"streetAddress"` // The user's surname (family name or last name). // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#surname User#surname} Surname *string `field:"optional" json:"surname" yaml:"surname"` // timeouts block. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#timeouts User#timeouts} Timeouts *UserTimeouts `field:"optional" json:"timeouts" yaml:"timeouts"` // The usage location of the user. // // Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#usage_location User#usage_location} UsageLocation *string `field:"optional" json:"usageLocation" yaml:"usageLocation"` }
type UserTimeouts ¶
type UserTimeouts struct { // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#create User#create}. Create *string `field:"optional" json:"create" yaml:"create"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#delete User#delete}. Delete *string `field:"optional" json:"delete" yaml:"delete"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#read User#read}. Read *string `field:"optional" json:"read" yaml:"read"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azuread/r/user#update User#update}. Update *string `field:"optional" json:"update" yaml:"update"` }
type UserTimeoutsOutputReference ¶
type UserTimeoutsOutputReference interface { cdktf.ComplexObject // the index of the complex object in a list. // Experimental. ComplexObjectIndex() interface{} // Experimental. SetComplexObjectIndex(val interface{}) // set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items. // Experimental. ComplexObjectIsFromSet() *bool // Experimental. SetComplexObjectIsFromSet(val *bool) Create() *string SetCreate(val *string) CreateInput() *string // The creation stack of this resolvable which will be appended to errors thrown during resolution. // // If this returns an empty array the stack will not be attached. // Experimental. CreationStack() *[]*string Delete() *string SetDelete(val *string) DeleteInput() *string // Experimental. Fqn() *string InternalValue() interface{} SetInternalValue(val interface{}) Read() *string SetRead(val *string) ReadInput() *string // Experimental. TerraformAttribute() *string // Experimental. SetTerraformAttribute(val *string) // Experimental. TerraformResource() cdktf.IInterpolatingParent // Experimental. SetTerraformResource(val cdktf.IInterpolatingParent) Update() *string SetUpdate(val *string) UpdateInput() *string // Experimental. ComputeFqn() *string // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationAsList() cdktf.IResolvable // Experimental. InterpolationForAttribute(property *string) cdktf.IResolvable ResetCreate() ResetDelete() ResetRead() ResetUpdate() // Produce the Token's value at resolution time. // Experimental. Resolve(_context cdktf.IResolveContext) interface{} // Return a string representation of this resolvable object. // // Returns a reversible string representation. // Experimental. ToString() *string }
func NewUserTimeoutsOutputReference ¶
func NewUserTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) UserTimeoutsOutputReference