Skip to content

applications.v1beta1.application

"Application is the Schema for the Applications API."

Index

Fields

fn new

new(name)

new returns an instance of Application

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ApplicationSpec defines the desired state of Application"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external\nwhen this managed resource is deleted - either \"Delete\" or \"Orphan\" the\nexternal resource.\nThis field is planned to be deprecated in favor of the ManagementPolicies\nfield in a future release. Currently, both could be set independently and\nnon-default values would be honored if the feature flag is enabled.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withApi

withApi(api)

"An api block as documented below, which configures API related settings for this application."

fn spec.forProvider.withApiMixin

withApiMixin(api)

"An api block as documented below, which configures API related settings for this application."

Note: This function appends passed data to existing values

fn spec.forProvider.withDescription

withDescription(description)

"A description of the application, as shown to end users.\nDescription of the application as shown to end users"

fn spec.forProvider.withDeviceOnlyAuthEnabled

withDeviceOnlyAuthEnabled(deviceOnlyAuthEnabled)

"Specifies whether this application supports device authentication without a user. Defaults to false.\nSpecifies whether this application supports device authentication without a user."

fn spec.forProvider.withDisplayName

withDisplayName(displayName)

"The display name for the application.\nThe display name for the application"

fn spec.forProvider.withFallbackPublicClientEnabled

withFallbackPublicClientEnabled(fallbackPublicClientEnabled)

"Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to false.\nSpecifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI"

fn spec.forProvider.withFeatureTags

withFeatureTags(featureTags)

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

fn spec.forProvider.withFeatureTagsMixin

withFeatureTagsMixin(featureTags)

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

Note: This function appends passed data to existing values

fn spec.forProvider.withGroupMembershipClaims

withGroupMembershipClaims(groupMembershipClaims)

"A set of strings containing membership claims issued in a user or OAuth 2.0 access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.\nConfigures the groups claim issued in a user or OAuth 2.0 access token that the app expects"

fn spec.forProvider.withGroupMembershipClaimsMixin

withGroupMembershipClaimsMixin(groupMembershipClaims)

"A set of strings containing membership claims issued in a user or OAuth 2.0 access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.\nConfigures the groups claim issued in a user or OAuth 2.0 access token that the app expects"

Note: This function appends passed data to existing values

fn spec.forProvider.withIdentifierUris

withIdentifierUris(identifierUris)

"A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.\nThe user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant"

fn spec.forProvider.withIdentifierUrisMixin

withIdentifierUrisMixin(identifierUris)

"A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.\nThe user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant"

Note: This function appends passed data to existing values

fn spec.forProvider.withLogoImage

withLogoImage(logoImage)

"A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.\nBase64 encoded logo image in gif, png or jpeg format"

fn spec.forProvider.withMarketingUrl

withMarketingUrl(marketingUrl)

"URL of the application's marketing page.\nURL of the application's marketing page"

fn spec.forProvider.withNotes

withNotes(notes)

"User-specified notes relevant for the management of the application.\nUser-specified notes relevant for the management of the application"

fn spec.forProvider.withOauth2PostResponseRequired

withOauth2PostResponseRequired(oauth2PostResponseRequired)

"Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to false, which specifies that only GET requests are allowed.\nSpecifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests."

fn spec.forProvider.withOptionalClaims

withOptionalClaims(optionalClaims)

"An optional_claims block as documented below."

fn spec.forProvider.withOptionalClaimsMixin

withOptionalClaimsMixin(optionalClaims)

"An optional_claims block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOwners

withOwners(owners)

"A set of object IDs of principals that will be granted ownership of the application. Supported object types are users or service principals. By default, no owners are assigned.\nA list of object IDs of principals that will be granted ownership of the application"

fn spec.forProvider.withOwnersMixin

withOwnersMixin(owners)

"A set of object IDs of principals that will be granted ownership of the application. Supported object types are users or service principals. By default, no owners are assigned.\nA list of object IDs of principals that will be granted ownership of the application"

Note: This function appends passed data to existing values

fn spec.forProvider.withPassword

withPassword(password)

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

fn spec.forProvider.withPasswordMixin

withPasswordMixin(password)

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

Note: This function appends passed data to existing values

fn spec.forProvider.withPreventDuplicateNames

withPreventDuplicateNames(preventDuplicateNames)

"If true, will return an error if an existing application is found with the same name. Defaults to false.\nIf true, will return an error if an existing application is found with the same name"

fn spec.forProvider.withPrivacyStatementUrl

withPrivacyStatementUrl(privacyStatementUrl)

"URL of the application's privacy statement.\nURL of the application's privacy statement"

fn spec.forProvider.withPublicClient

withPublicClient(publicClient)

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

fn spec.forProvider.withPublicClientMixin

withPublicClientMixin(publicClient)

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

Note: This function appends passed data to existing values

fn spec.forProvider.withRequiredResourceAccess

withRequiredResourceAccess(requiredResourceAccess)

"A collection of required_resource_access blocks as documented below."

fn spec.forProvider.withRequiredResourceAccessMixin

withRequiredResourceAccessMixin(requiredResourceAccess)

"A collection of required_resource_access blocks as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withServiceManagementReference

withServiceManagementReference(serviceManagementReference)

"References application context information from a Service or Asset Management database.\nReferences application or service contact information from a Service or Asset Management database"

fn spec.forProvider.withSignInAudience

withSignInAudience(signInAudience)

"The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.\nThe Microsoft account types that are supported for the current application"

fn spec.forProvider.withSinglePageApplication

withSinglePageApplication(singlePageApplication)

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

fn spec.forProvider.withSinglePageApplicationMixin

withSinglePageApplicationMixin(singlePageApplication)

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

Note: This function appends passed data to existing values

fn spec.forProvider.withSupportUrl

withSupportUrl(supportUrl)

"URL of the application's support page.\nURL of the application's support page"

fn spec.forProvider.withTags

withTags(tags)

"A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the feature_tags block.\nA set of tags to apply to the application"

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the feature_tags block.\nA set of tags to apply to the application"

Note: This function appends passed data to existing values

fn spec.forProvider.withTemplateId

withTemplateId(templateId)

"Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.\nUnique ID of the application template from which this application is created"

fn spec.forProvider.withTermsOfServiceUrl

withTermsOfServiceUrl(termsOfServiceUrl)

"URL of the application's terms of service statement.\nURL of the application's terms of service statement"

fn spec.forProvider.withWeb

withWeb(web)

"A web block as documented below, which configures web related settings for this application."

fn spec.forProvider.withWebMixin

withWebMixin(web)

"A web block as documented below, which configures web related settings for this application."

Note: This function appends passed data to existing values

obj spec.forProvider.api

"An api block as documented below, which configures API related settings for this application."

fn spec.forProvider.api.withKnownClientApplications

withKnownClientApplications(knownClientApplications)

"A set of client IDs, used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.\nUsed for bundling consent if you have a solution that contains two parts: a client app and a custom web API app"

fn spec.forProvider.api.withKnownClientApplicationsMixin

withKnownClientApplicationsMixin(knownClientApplications)

"A set of client IDs, used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.\nUsed for bundling consent if you have a solution that contains two parts: a client app and a custom web API app"

Note: This function appends passed data to existing values

fn spec.forProvider.api.withKnownClientApplicationsRefs

withKnownClientApplicationsRefs(knownClientApplicationsRefs)

"References to Application in applications to populate knownClientApplications."

fn spec.forProvider.api.withKnownClientApplicationsRefsMixin

withKnownClientApplicationsRefsMixin(knownClientApplicationsRefs)

"References to Application in applications to populate knownClientApplications."

Note: This function appends passed data to existing values

fn spec.forProvider.api.withMappedClaimsEnabled

withMappedClaimsEnabled(mappedClaimsEnabled)

"Allows an application to use claims mapping without specifying a custom signing key. Defaults to false.\nAllows an application to use claims mapping without specifying a custom signing key"

fn spec.forProvider.api.withOauth2PermissionScope

withOauth2PermissionScope(oauth2PermissionScope)

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

fn spec.forProvider.api.withOauth2PermissionScopeMixin

withOauth2PermissionScopeMixin(oauth2PermissionScope)

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

Note: This function appends passed data to existing values

fn spec.forProvider.api.withRequestedAccessTokenVersion

withRequestedAccessTokenVersion(requestedAccessTokenVersion)

"The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 1.\nThe access token version expected by this resource"

obj spec.forProvider.api.knownClientApplicationsRefs

"References to Application in applications to populate knownClientApplications."

fn spec.forProvider.api.knownClientApplicationsRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.api.knownClientApplicationsRefs.policy

"Policies for referencing."

fn spec.forProvider.api.knownClientApplicationsRefs.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.api.knownClientApplicationsRefs.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.api.knownClientApplicationsSelector

"Selector for a list of Application in applications to populate knownClientApplications."

fn spec.forProvider.api.knownClientApplicationsSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.forProvider.api.knownClientApplicationsSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.api.knownClientApplicationsSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.api.knownClientApplicationsSelector.policy

"Policies for selection."

fn spec.forProvider.api.knownClientApplicationsSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.api.knownClientApplicationsSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.api.oauth2PermissionScope

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

fn spec.forProvider.api.oauth2PermissionScope.withAdminConsentDescription

withAdminConsentDescription(adminConsentDescription)

"Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.\nDelegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users"

fn spec.forProvider.api.oauth2PermissionScope.withAdminConsentDisplayName

withAdminConsentDisplayName(adminConsentDisplayName)

"Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.\nDisplay name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users"

fn spec.forProvider.api.oauth2PermissionScope.withEnabled

withEnabled(enabled)

"Determines if the permission scope is enabled. Defaults to true.\nDetermines if the permission scope is enabled"

fn spec.forProvider.api.oauth2PermissionScope.withId

withId(id)

"The unique identifier of the delegated permission. Must be a valid UUID.\nThe unique identifier of the delegated permission"

fn spec.forProvider.api.oauth2PermissionScope.withType

withType(type)

"Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Defaults to User. Possible values are User or Admin.\nWhether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions"

fn spec.forProvider.api.oauth2PermissionScope.withUserConsentDescription

withUserConsentDescription(userConsentDescription)

"Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.\nDelegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf"

fn spec.forProvider.api.oauth2PermissionScope.withUserConsentDisplayName

withUserConsentDisplayName(userConsentDisplayName)

"Display name for the delegated permission that appears in the end user consent experience.\nDisplay name for the delegated permission that appears in the end user consent experience"

fn spec.forProvider.api.oauth2PermissionScope.withValue

withValue(value)

"The value that is used for the scp claim in OAuth 2.0 access tokens.\nThe value that is used for the scp claim in OAuth 2.0 access tokens"

obj spec.forProvider.featureTags

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

fn spec.forProvider.featureTags.withCustomSingleSignOn

withCustomSingleSignOn(customSingleSignOn)

"Whether this application represents a custom SAML application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryCustomSingleSignOnApplication tag. Defaults to false.\nWhether this application represents a custom SAML application for linked service principals"

fn spec.forProvider.featureTags.withEnterprise

withEnterprise(enterprise)

"Whether this application represents an Enterprise Application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryIntegratedApp tag. Defaults to false.\nWhether this application represents an Enterprise Application for linked service principals"

fn spec.forProvider.featureTags.withGallery

withGallery(gallery)

"Whether this application represents a gallery application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1 tag. Defaults to false.\nWhether this application represents a gallery application for linked service principals"

fn spec.forProvider.featureTags.withHide

withHide(hide)

"Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the HideApp tag. Defaults to false.\nWhether this application is invisible to users in My Apps and Office 365 Launcher"

obj spec.forProvider.optionalClaims

"An optional_claims block as documented below."

fn spec.forProvider.optionalClaims.withAccessToken

withAccessToken(accessToken)

"One or more access_token blocks as documented below."

fn spec.forProvider.optionalClaims.withAccessTokenMixin

withAccessTokenMixin(accessToken)

"One or more access_token blocks as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.optionalClaims.withIdToken

withIdToken(idToken)

"One or more id_token blocks as documented below."

fn spec.forProvider.optionalClaims.withIdTokenMixin

withIdTokenMixin(idToken)

"One or more id_token blocks as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.optionalClaims.withSaml2Token

withSaml2Token(saml2Token)

"One or more saml2_token blocks as documented below."

fn spec.forProvider.optionalClaims.withSaml2TokenMixin

withSaml2TokenMixin(saml2Token)

"One or more saml2_token blocks as documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.optionalClaims.accessToken

"One or more access_token blocks as documented below."

fn spec.forProvider.optionalClaims.accessToken.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.forProvider.optionalClaims.accessToken.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.forProvider.optionalClaims.accessToken.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.forProvider.optionalClaims.accessToken.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.forProvider.optionalClaims.accessToken.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.forProvider.optionalClaims.idToken

"One or more id_token blocks as documented below."

fn spec.forProvider.optionalClaims.idToken.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.forProvider.optionalClaims.idToken.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.forProvider.optionalClaims.idToken.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.forProvider.optionalClaims.idToken.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.forProvider.optionalClaims.idToken.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.forProvider.optionalClaims.saml2Token

"One or more saml2_token blocks as documented below."

fn spec.forProvider.optionalClaims.saml2Token.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.forProvider.optionalClaims.saml2Token.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.forProvider.optionalClaims.saml2Token.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.forProvider.optionalClaims.saml2Token.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.forProvider.optionalClaims.saml2Token.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.forProvider.password

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

fn spec.forProvider.password.withDisplayName

withDisplayName(displayName)

"A display name for the password. Changing this field forces a new resource to be created.\nA display name for the password"

fn spec.forProvider.password.withEndDate

withEndDate(endDate)

"The end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.\nThe end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z)"

fn spec.forProvider.password.withStartDate

withStartDate(startDate)

"The start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used. Changing this field forces a new resource to be created.\nThe start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used"

obj spec.forProvider.publicClient

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

fn spec.forProvider.publicClient.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https or ms-appx-web URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.forProvider.publicClient.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https or ms-appx-web URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.forProvider.requiredResourceAccess

"A collection of required_resource_access blocks as documented below."

fn spec.forProvider.requiredResourceAccess.withResourceAccess

withResourceAccess(resourceAccess)

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

fn spec.forProvider.requiredResourceAccess.withResourceAccessMixin

withResourceAccessMixin(resourceAccess)

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

Note: This function appends passed data to existing values

fn spec.forProvider.requiredResourceAccess.withResourceAppId

withResourceAppId(resourceAppId)

"The unique identifier for the resource that the application requires access to. This should be the Application ID of the target application."

obj spec.forProvider.requiredResourceAccess.resourceAccess

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

fn spec.forProvider.requiredResourceAccess.resourceAccess.withId

withId(id)

"The unique identifier for an app role or OAuth2 permission scope published by the resource application."

fn spec.forProvider.requiredResourceAccess.resourceAccess.withType

withType(type)

"Specifies whether the id property references an app role or an OAuth2 permission scope. Possible values are Role or Scope."

obj spec.forProvider.singlePageApplication

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

fn spec.forProvider.singlePageApplication.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.forProvider.singlePageApplication.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.forProvider.web

"A web block as documented below, which configures web related settings for this application."

fn spec.forProvider.web.withHomepageUrl

withHomepageUrl(homepageUrl)

"Home page or landing page of the application.\nHome page or landing page of the application"

fn spec.forProvider.web.withImplicitGrant

withImplicitGrant(implicitGrant)

"An implicit_grant block as documented above."

fn spec.forProvider.web.withImplicitGrantMixin

withImplicitGrantMixin(implicitGrant)

"An implicit_grant block as documented above."

Note: This function appends passed data to existing values

fn spec.forProvider.web.withLogoutUrl

withLogoutUrl(logoutUrl)

"The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.\nThe URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols"

fn spec.forProvider.web.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid http URL or a URN.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.forProvider.web.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid http URL or a URN.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.forProvider.web.implicitGrant

"An implicit_grant block as documented above."

fn spec.forProvider.web.implicitGrant.withAccessTokenIssuanceEnabled

withAccessTokenIssuanceEnabled(accessTokenIssuanceEnabled)

"Whether this web application can request an access token using OAuth 2.0 implicit flow.\nWhether this web application can request an access token using OAuth 2.0 implicit flow"

fn spec.forProvider.web.implicitGrant.withIdTokenIssuanceEnabled

withIdTokenIssuanceEnabled(idTokenIssuanceEnabled)

"Whether this web application can request an ID token using OAuth 2.0 implicit flow.\nWhether this web application can request an ID token using OAuth 2.0 implicit flow"

obj spec.initProvider

"THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler."

fn spec.initProvider.withApi

withApi(api)

"An api block as documented below, which configures API related settings for this application."

fn spec.initProvider.withApiMixin

withApiMixin(api)

"An api block as documented below, which configures API related settings for this application."

Note: This function appends passed data to existing values

fn spec.initProvider.withDescription

withDescription(description)

"A description of the application, as shown to end users.\nDescription of the application as shown to end users"

fn spec.initProvider.withDeviceOnlyAuthEnabled

withDeviceOnlyAuthEnabled(deviceOnlyAuthEnabled)

"Specifies whether this application supports device authentication without a user. Defaults to false.\nSpecifies whether this application supports device authentication without a user."

fn spec.initProvider.withDisplayName

withDisplayName(displayName)

"The display name for the application.\nThe display name for the application"

fn spec.initProvider.withFallbackPublicClientEnabled

withFallbackPublicClientEnabled(fallbackPublicClientEnabled)

"Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to false.\nSpecifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI"

fn spec.initProvider.withFeatureTags

withFeatureTags(featureTags)

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

fn spec.initProvider.withFeatureTagsMixin

withFeatureTagsMixin(featureTags)

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

Note: This function appends passed data to existing values

fn spec.initProvider.withGroupMembershipClaims

withGroupMembershipClaims(groupMembershipClaims)

"A set of strings containing membership claims issued in a user or OAuth 2.0 access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.\nConfigures the groups claim issued in a user or OAuth 2.0 access token that the app expects"

fn spec.initProvider.withGroupMembershipClaimsMixin

withGroupMembershipClaimsMixin(groupMembershipClaims)

"A set of strings containing membership claims issued in a user or OAuth 2.0 access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.\nConfigures the groups claim issued in a user or OAuth 2.0 access token that the app expects"

Note: This function appends passed data to existing values

fn spec.initProvider.withIdentifierUris

withIdentifierUris(identifierUris)

"A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.\nThe user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant"

fn spec.initProvider.withIdentifierUrisMixin

withIdentifierUrisMixin(identifierUris)

"A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.\nThe user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant"

Note: This function appends passed data to existing values

fn spec.initProvider.withLogoImage

withLogoImage(logoImage)

"A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.\nBase64 encoded logo image in gif, png or jpeg format"

fn spec.initProvider.withMarketingUrl

withMarketingUrl(marketingUrl)

"URL of the application's marketing page.\nURL of the application's marketing page"

fn spec.initProvider.withNotes

withNotes(notes)

"User-specified notes relevant for the management of the application.\nUser-specified notes relevant for the management of the application"

fn spec.initProvider.withOauth2PostResponseRequired

withOauth2PostResponseRequired(oauth2PostResponseRequired)

"Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to false, which specifies that only GET requests are allowed.\nSpecifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests."

fn spec.initProvider.withOptionalClaims

withOptionalClaims(optionalClaims)

"An optional_claims block as documented below."

fn spec.initProvider.withOptionalClaimsMixin

withOptionalClaimsMixin(optionalClaims)

"An optional_claims block as documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withOwners

withOwners(owners)

"A set of object IDs of principals that will be granted ownership of the application. Supported object types are users or service principals. By default, no owners are assigned.\nA list of object IDs of principals that will be granted ownership of the application"

fn spec.initProvider.withOwnersMixin

withOwnersMixin(owners)

"A set of object IDs of principals that will be granted ownership of the application. Supported object types are users or service principals. By default, no owners are assigned.\nA list of object IDs of principals that will be granted ownership of the application"

Note: This function appends passed data to existing values

fn spec.initProvider.withPassword

withPassword(password)

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

fn spec.initProvider.withPasswordMixin

withPasswordMixin(password)

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

Note: This function appends passed data to existing values

fn spec.initProvider.withPreventDuplicateNames

withPreventDuplicateNames(preventDuplicateNames)

"If true, will return an error if an existing application is found with the same name. Defaults to false.\nIf true, will return an error if an existing application is found with the same name"

fn spec.initProvider.withPrivacyStatementUrl

withPrivacyStatementUrl(privacyStatementUrl)

"URL of the application's privacy statement.\nURL of the application's privacy statement"

fn spec.initProvider.withPublicClient

withPublicClient(publicClient)

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

fn spec.initProvider.withPublicClientMixin

withPublicClientMixin(publicClient)

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

Note: This function appends passed data to existing values

fn spec.initProvider.withRequiredResourceAccess

withRequiredResourceAccess(requiredResourceAccess)

"A collection of required_resource_access blocks as documented below."

fn spec.initProvider.withRequiredResourceAccessMixin

withRequiredResourceAccessMixin(requiredResourceAccess)

"A collection of required_resource_access blocks as documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withServiceManagementReference

withServiceManagementReference(serviceManagementReference)

"References application context information from a Service or Asset Management database.\nReferences application or service contact information from a Service or Asset Management database"

fn spec.initProvider.withSignInAudience

withSignInAudience(signInAudience)

"The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.\nThe Microsoft account types that are supported for the current application"

fn spec.initProvider.withSinglePageApplication

withSinglePageApplication(singlePageApplication)

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

fn spec.initProvider.withSinglePageApplicationMixin

withSinglePageApplicationMixin(singlePageApplication)

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

Note: This function appends passed data to existing values

fn spec.initProvider.withSupportUrl

withSupportUrl(supportUrl)

"URL of the application's support page.\nURL of the application's support page"

fn spec.initProvider.withTags

withTags(tags)

"A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the feature_tags block.\nA set of tags to apply to the application"

fn spec.initProvider.withTagsMixin

withTagsMixin(tags)

"A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the feature_tags block.\nA set of tags to apply to the application"

Note: This function appends passed data to existing values

fn spec.initProvider.withTemplateId

withTemplateId(templateId)

"Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.\nUnique ID of the application template from which this application is created"

fn spec.initProvider.withTermsOfServiceUrl

withTermsOfServiceUrl(termsOfServiceUrl)

"URL of the application's terms of service statement.\nURL of the application's terms of service statement"

fn spec.initProvider.withWeb

withWeb(web)

"A web block as documented below, which configures web related settings for this application."

fn spec.initProvider.withWebMixin

withWebMixin(web)

"A web block as documented below, which configures web related settings for this application."

Note: This function appends passed data to existing values

obj spec.initProvider.api

"An api block as documented below, which configures API related settings for this application."

fn spec.initProvider.api.withKnownClientApplications

withKnownClientApplications(knownClientApplications)

"A set of client IDs, used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.\nUsed for bundling consent if you have a solution that contains two parts: a client app and a custom web API app"

fn spec.initProvider.api.withKnownClientApplicationsMixin

withKnownClientApplicationsMixin(knownClientApplications)

"A set of client IDs, used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.\nUsed for bundling consent if you have a solution that contains two parts: a client app and a custom web API app"

Note: This function appends passed data to existing values

fn spec.initProvider.api.withKnownClientApplicationsRefs

withKnownClientApplicationsRefs(knownClientApplicationsRefs)

"References to Application in applications to populate knownClientApplications."

fn spec.initProvider.api.withKnownClientApplicationsRefsMixin

withKnownClientApplicationsRefsMixin(knownClientApplicationsRefs)

"References to Application in applications to populate knownClientApplications."

Note: This function appends passed data to existing values

fn spec.initProvider.api.withMappedClaimsEnabled

withMappedClaimsEnabled(mappedClaimsEnabled)

"Allows an application to use claims mapping without specifying a custom signing key. Defaults to false.\nAllows an application to use claims mapping without specifying a custom signing key"

fn spec.initProvider.api.withOauth2PermissionScope

withOauth2PermissionScope(oauth2PermissionScope)

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

fn spec.initProvider.api.withOauth2PermissionScopeMixin

withOauth2PermissionScopeMixin(oauth2PermissionScope)

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

Note: This function appends passed data to existing values

fn spec.initProvider.api.withRequestedAccessTokenVersion

withRequestedAccessTokenVersion(requestedAccessTokenVersion)

"The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 1.\nThe access token version expected by this resource"

obj spec.initProvider.api.knownClientApplicationsRefs

"References to Application in applications to populate knownClientApplications."

fn spec.initProvider.api.knownClientApplicationsRefs.withName

withName(name)

"Name of the referenced object."

obj spec.initProvider.api.knownClientApplicationsRefs.policy

"Policies for referencing."

fn spec.initProvider.api.knownClientApplicationsRefs.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.api.knownClientApplicationsRefs.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.api.knownClientApplicationsSelector

"Selector for a list of Application in applications to populate knownClientApplications."

fn spec.initProvider.api.knownClientApplicationsSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.initProvider.api.knownClientApplicationsSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.initProvider.api.knownClientApplicationsSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.initProvider.api.knownClientApplicationsSelector.policy

"Policies for selection."

fn spec.initProvider.api.knownClientApplicationsSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.api.knownClientApplicationsSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.api.oauth2PermissionScope

"One or more oauth2_permission_scope blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.\nOne or more oauth2_permission_scope blocks to describe delegated permissions exposed by the web API represented by this application"

fn spec.initProvider.api.oauth2PermissionScope.withAdminConsentDescription

withAdminConsentDescription(adminConsentDescription)

"Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.\nDelegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users"

fn spec.initProvider.api.oauth2PermissionScope.withAdminConsentDisplayName

withAdminConsentDisplayName(adminConsentDisplayName)

"Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.\nDisplay name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users"

fn spec.initProvider.api.oauth2PermissionScope.withEnabled

withEnabled(enabled)

"Determines if the permission scope is enabled. Defaults to true.\nDetermines if the permission scope is enabled"

fn spec.initProvider.api.oauth2PermissionScope.withId

withId(id)

"The unique identifier of the delegated permission. Must be a valid UUID.\nThe unique identifier of the delegated permission"

fn spec.initProvider.api.oauth2PermissionScope.withType

withType(type)

"Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Defaults to User. Possible values are User or Admin.\nWhether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions"

fn spec.initProvider.api.oauth2PermissionScope.withUserConsentDescription

withUserConsentDescription(userConsentDescription)

"Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.\nDelegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf"

fn spec.initProvider.api.oauth2PermissionScope.withUserConsentDisplayName

withUserConsentDisplayName(userConsentDisplayName)

"Display name for the delegated permission that appears in the end user consent experience.\nDisplay name for the delegated permission that appears in the end user consent experience"

fn spec.initProvider.api.oauth2PermissionScope.withValue

withValue(value)

"The value that is used for the scp claim in OAuth 2.0 access tokens.\nThe value that is used for the scp claim in OAuth 2.0 access tokens"

obj spec.initProvider.featureTags

"A feature_tags block as described below. Cannot be used together with the tags property.\nBlock of features to configure for this application using tags"

fn spec.initProvider.featureTags.withCustomSingleSignOn

withCustomSingleSignOn(customSingleSignOn)

"Whether this application represents a custom SAML application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryCustomSingleSignOnApplication tag. Defaults to false.\nWhether this application represents a custom SAML application for linked service principals"

fn spec.initProvider.featureTags.withEnterprise

withEnterprise(enterprise)

"Whether this application represents an Enterprise Application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryIntegratedApp tag. Defaults to false.\nWhether this application represents an Enterprise Application for linked service principals"

fn spec.initProvider.featureTags.withGallery

withGallery(gallery)

"Whether this application represents a gallery application for linked service principals. Enabling this will assign the WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1 tag. Defaults to false.\nWhether this application represents a gallery application for linked service principals"

fn spec.initProvider.featureTags.withHide

withHide(hide)

"Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the HideApp tag. Defaults to false.\nWhether this application is invisible to users in My Apps and Office 365 Launcher"

obj spec.initProvider.optionalClaims

"An optional_claims block as documented below."

fn spec.initProvider.optionalClaims.withAccessToken

withAccessToken(accessToken)

"One or more access_token blocks as documented below."

fn spec.initProvider.optionalClaims.withAccessTokenMixin

withAccessTokenMixin(accessToken)

"One or more access_token blocks as documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.optionalClaims.withIdToken

withIdToken(idToken)

"One or more id_token blocks as documented below."

fn spec.initProvider.optionalClaims.withIdTokenMixin

withIdTokenMixin(idToken)

"One or more id_token blocks as documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.optionalClaims.withSaml2Token

withSaml2Token(saml2Token)

"One or more saml2_token blocks as documented below."

fn spec.initProvider.optionalClaims.withSaml2TokenMixin

withSaml2TokenMixin(saml2Token)

"One or more saml2_token blocks as documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.optionalClaims.accessToken

"One or more access_token blocks as documented below."

fn spec.initProvider.optionalClaims.accessToken.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.initProvider.optionalClaims.accessToken.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.initProvider.optionalClaims.accessToken.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.initProvider.optionalClaims.accessToken.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.initProvider.optionalClaims.accessToken.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.initProvider.optionalClaims.idToken

"One or more id_token blocks as documented below."

fn spec.initProvider.optionalClaims.idToken.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.initProvider.optionalClaims.idToken.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.initProvider.optionalClaims.idToken.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.initProvider.optionalClaims.idToken.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.initProvider.optionalClaims.idToken.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.initProvider.optionalClaims.saml2Token

"One or more saml2_token blocks as documented below."

fn spec.initProvider.optionalClaims.saml2Token.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

fn spec.initProvider.optionalClaims.saml2Token.withAdditionalPropertiesMixin

withAdditionalPropertiesMixin(additionalProperties)

"List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.\nList of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim"

Note: This function appends passed data to existing values

fn spec.initProvider.optionalClaims.saml2Token.withEssential

withEssential(essential)

"Whether the claim specified by the client is necessary to ensure a smooth authorization experience.\nWhether the claim specified by the client is necessary to ensure a smooth authorization experience"

fn spec.initProvider.optionalClaims.saml2Token.withName

withName(name)

"The name of the optional claim.\nThe name of the optional claim"

fn spec.initProvider.optionalClaims.saml2Token.withSource

withSource(source)

"The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.\nThe source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object"

obj spec.initProvider.password

"A single password block as documented below. The password is generated during creation. By default, no password is generated.\nApp password definition"

fn spec.initProvider.password.withDisplayName

withDisplayName(displayName)

"A display name for the password. Changing this field forces a new resource to be created.\nA display name for the password"

fn spec.initProvider.password.withEndDate

withEndDate(endDate)

"The end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.\nThe end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z)"

fn spec.initProvider.password.withStartDate

withStartDate(startDate)

"The start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used. Changing this field forces a new resource to be created.\nThe start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used"

obj spec.initProvider.publicClient

"A public_client block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device."

fn spec.initProvider.publicClient.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https or ms-appx-web URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.initProvider.publicClient.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https or ms-appx-web URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.initProvider.requiredResourceAccess

"A collection of required_resource_access blocks as documented below."

fn spec.initProvider.requiredResourceAccess.withResourceAccess

withResourceAccess(resourceAccess)

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

fn spec.initProvider.requiredResourceAccess.withResourceAccessMixin

withResourceAccessMixin(resourceAccess)

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

Note: This function appends passed data to existing values

fn spec.initProvider.requiredResourceAccess.withResourceAppId

withResourceAppId(resourceAppId)

"The unique identifier for the resource that the application requires access to. This should be the Application ID of the target application."

obj spec.initProvider.requiredResourceAccess.resourceAccess

"A collection of resource_access blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource."

fn spec.initProvider.requiredResourceAccess.resourceAccess.withId

withId(id)

"The unique identifier for an app role or OAuth2 permission scope published by the resource application."

fn spec.initProvider.requiredResourceAccess.resourceAccess.withType

withType(type)

"Specifies whether the id property references an app role or an OAuth2 permission scope. Possible values are Role or Scope."

obj spec.initProvider.singlePageApplication

"A single_page_application block as documented below, which configures single-page application (SPA) related settings for this application."

fn spec.initProvider.singlePageApplication.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.initProvider.singlePageApplication.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid https URL.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.initProvider.web

"A web block as documented below, which configures web related settings for this application."

fn spec.initProvider.web.withHomepageUrl

withHomepageUrl(homepageUrl)

"Home page or landing page of the application.\nHome page or landing page of the application"

fn spec.initProvider.web.withImplicitGrant

withImplicitGrant(implicitGrant)

"An implicit_grant block as documented above."

fn spec.initProvider.web.withImplicitGrantMixin

withImplicitGrantMixin(implicitGrant)

"An implicit_grant block as documented above."

Note: This function appends passed data to existing values

fn spec.initProvider.web.withLogoutUrl

withLogoutUrl(logoutUrl)

"The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.\nThe URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols"

fn spec.initProvider.web.withRedirectUris

withRedirectUris(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid http URL or a URN.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

fn spec.initProvider.web.withRedirectUrisMixin

withRedirectUrisMixin(redirectUris)

"A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid http URL or a URN.\nThe URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent"

Note: This function appends passed data to existing values

obj spec.initProvider.web.implicitGrant

"An implicit_grant block as documented above."

fn spec.initProvider.web.implicitGrant.withAccessTokenIssuanceEnabled

withAccessTokenIssuanceEnabled(accessTokenIssuanceEnabled)

"Whether this web application can request an access token using OAuth 2.0 implicit flow.\nWhether this web application can request an access token using OAuth 2.0 implicit flow"

fn spec.initProvider.web.implicitGrant.withIdTokenIssuanceEnabled

withIdTokenIssuanceEnabled(idTokenIssuanceEnabled)

"Whether this web application can request an ID token using OAuth 2.0 implicit flow.\nWhether this web application can request an ID token using OAuth 2.0 implicit flow"

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."