MicrosoftGraphServicePrincipal Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10

Assembly:: Az.MSGraph.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphServicePrincipalTypeConverter))]
public class MicrosoftGraphServicePrincipal : Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal, Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Runtime.IAssociativeArray<object>, Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphServicePrincipalTypeConverter))>]
type MicrosoftGraphServicePrincipal = class
    interface IMicrosoftGraphServicePrincipal
    interface IJsonSerializable
    interface IMicrosoftGraphDirectoryObject
    interface IMicrosoftGraphEntityAutoGenerated
    interface IAssociativeArray<obj>
    interface IValidates

Public Class MicrosoftGraphServicePrincipal
Implements IAssociativeArray(Of Object), IMicrosoftGraphServicePrincipal, IValidates

Inheritance: Object
MicrosoftGraphServicePrincipal

Attributes: TypeConverterAttribute

Implements: IMicrosoftGraphDirectoryObject IMicrosoftGraphEntityAutoGenerated IMicrosoftGraphServicePrincipal IAssociativeArray<Object> IJsonSerializable IValidates

Constructors

MicrosoftGraphServicePrincipal()

Creates an new MicrosoftGraphServicePrincipal instance.

Fields

__additionalProperties

Properties

AccountEnabled	true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in).
AddIn	Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on.
AlternativeName	Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith).
AppDescription	The description exposed by the associated application.
AppDisplayName	The display name exposed by the associated application.
AppId	The unique identifier for the associated application (its appId property).
ApplicationTemplateId	Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).
AppOwnerOrganizationId	Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le).
AppRole	The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable.
AppRoleAssignedTo	App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.
AppRoleAssignment	App role assignment for another app or service, granted to this service principal. Supports $expand.
AppRoleAssignmentRequired	Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).
ClaimsMappingPolicy	The claimsMappingPolicies assigned to this service principal. Supports $expand.
CreatedObject	Directory objects created by this service principal. Read-only. Nullable.
DelegatedPermissionClassification	The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand.
DeletedDateTime
Description	Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
DisabledByMicrosoftStatus	Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT).
DisplayName	The name displayed in directory
Endpoint	Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
FederatedIdentityCredentials
Homepage	Home page or landing page of the application.
HomeRealmDiscoveryPolicy	The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.
Id	Read-only.
Info	informationalUrl
Item[String]
KeyCredentials	The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le).
LoginUrl	Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
LogoutUrl	Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
MemberOf	Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.
Note	Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.
NotificationEmailAddress	Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
Oauth2PermissionGrant	Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.
Oauth2PermissionScope	The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.
OdataId	The full id of object in directory
OdataType	The type of object in directory
OwnedObject	Directory objects that are owned by this service principal. Read-only. Nullable. Supports $expand.
Owner	Directory objects that are owners of this servicePrincipal. The owners are a set of non-admin users or servicePrincipals who are allowed to modify this object. Read-only. Nullable. Supports $expand.
PasswordCredentials	The collection of password credentials associated with the service principal. Not nullable.
PreferredSingleSignOnMode	Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.
PreferredTokenSigningKeyThumbprint	Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.
ReplyUrl	The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.
ResourceGroupName	Gets the resource group name
SamlSingleSignOnSetting	samlSingleSignOnSettings
ServicePrincipalName	Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
ServicePrincipalType	Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity.
SignInAudience	Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Azure AD tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Azure AD tenant (multi-tenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Azure AD tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
Tag	Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).
TokenEncryptionKeyId	Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
TokenIssuancePolicy	The tokenIssuancePolicies assigned to this service principal. Supports $expand.
TokenLifetimePolicy	The tokenLifetimePolicies assigned to this service principal. Supports $expand.
TransitiveMemberOf

Methods

Add(String, Object)
Clear()
ContainsKey(String)
CopyFrom(IDictionary)
CopyFrom(PSObject)
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of MicrosoftGraphServicePrincipal.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of MicrosoftGraphServicePrincipal.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal.
FromJsonString(String)	Creates a new instance of MicrosoftGraphServicePrincipal, deserializing the content from a json string.
Remove(String)
ToJson(JsonObject, SerializationMode)	Serializes this instance of MicrosoftGraphServicePrincipal into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
TryGetValue(String, Object)
Validate(IEventListener)	Validates that this object meets the validation criteria.

Operators

Implicit(MicrosoftGraphServicePrincipal to Dictionary<String,Object>)

Explicit Interface Implementations

IAssociativeArray<Object>.AdditionalProperties

Applies to

Share via