Share via

Set-MgBetaOrganizationBrandingLocalizationBackgroundImage

Module:
Microsoft.Graph.Beta.Identity.DirectoryManagement Module

Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image reduces bandwidth requirements and make the page load faster.

Note

To view the v1.0 release of this cmdlet, view Set-MgOrganizationBrandingLocalizationBackgroundImage

Syntax

Set (Default) 

Set-MgBetaOrganizationBrandingLocalizationBackgroundImage
    -OrganizationId <String>
    -OrganizationalBrandingLocalizationId <String>
    -InFile <String>
    [-Data <Stream>]
    [-ResponseHeadersVariable <String>]
    [-ContentType <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetViaIdentity 

Set-MgBetaOrganizationBrandingLocalizationBackgroundImage
    -InputObject <IIdentityDirectoryManagementIdentity>
    -InFile <String>
    [-Data <Stream>]
    [-ResponseHeadersVariable <String>]
    [-ContentType <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image reduces bandwidth requirements and make the page load faster.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) OrganizationalBranding.ReadWrite.All, Organization.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application OrganizationalBranding.ReadWrite.All, Organization.ReadWrite.All,

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentType

ContentType Parameter

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Data

Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image reduces bandwidth requirements and make the page load faster.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) OrganizationalBranding.ReadWrite.All, Organization.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application OrganizationalBranding.ReadWrite.All, Organization.ReadWrite.All,

Parameter properties

Type:Stream
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InFile

The path to the file to upload. This should include a path and file name. If you omit the path, the current ___location will be used.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IIdentityDirectoryManagementIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-OrganizationalBrandingLocalizationId

The unique identifier of organizationalBrandingLocalization

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Set
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OrganizationId

The unique identifier of organization

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Set
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

System.Collections.IDictionary

System.IO.Stream

System.String

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter

  • [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
  • [AllowedValueId <String>]: The unique identifier of allowedValue
  • [AttributeSetId <String>]: The unique identifier of attributeSet
  • [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity
  • [CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail
  • [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration
  • [CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki
  • [CommandId <String>]: The unique identifier of command
  • [CommerceSubscriptionId <String>]: Alternate key of companySubscription
  • [CompanySubscriptionId <String>]: The unique identifier of companySubscription
  • [ContractId <String>]: The unique identifier of contract
  • [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
  • [DeviceId <String>]: The unique identifier of device
  • [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
  • [DeviceTemplateId <String>]: The unique identifier of deviceTemplate
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [DirectoryRoleId <String>]: The unique identifier of directoryRole
  • [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
  • [DirectorySettingId <String>]: The unique identifier of directorySetting
  • [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate
  • [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
  • [DomainId <String>]: The unique identifier of ___domain
  • [DomainName <String>]: Usage: domainName='{domainName}'
  • [ExtensionId <String>]: The unique identifier of extension
  • [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile
  • [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy
  • [HardwareOathTokenAuthenticationMethodDeviceId <String>]: The unique identifier of hardwareOathTokenAuthenticationMethodDevice
  • [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
  • [ImpactedResourceId <String>]: The unique identifier of impactedResource
  • [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile
  • [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
  • [MutualTlsOauthConfigurationId <String>]: The unique identifier of mutualTlsOauthConfiguration
  • [OcpSubscriptionId <String>]: Alternate key of companySubscription
  • [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
  • [OrgContactId <String>]: The unique identifier of orgContact
  • [OrganizationId <String>]: The unique identifier of organization
  • [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
  • [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile
  • [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile
  • [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
  • [RecommendationId <String>]: The unique identifier of recommendation
  • [RoleTemplateId <String>]: Alternate key of directoryRole
  • [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
  • [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain
  • [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation
  • [SubscribedSkuId <String>]: The unique identifier of subscribedSku
  • [TenantId <String>]: Usage: tenantId='{tenantId}'
  • [TenantReferenceTenantId <String>]: The unique identifier of tenantReference
  • [UsageRightId <String>]: The unique identifier of usageRight
  • [UserId <String>]: The unique identifier of user