[Index]

Model: device/msonline/MsolServicePrincipal

Model Details: device/msonline/MsolServicePrincipal

Title Description Details
StartDate The effective start date of the credential usage. The default start date value is today.
  • Field Name: StartDate
  • Type: String
  • Format: date-time
AccountEnabled Specifies if the account needs to be enabled. This will be set to true if not specified.
  • Field Name: AccountEnabled
  • Type: Boolean
EndDate The effective end date of the credential usage. The default end date value is one year from today.
  • Field Name: EndDate
  • Type: String
  • Format: date-time
Addresses List of addresses used by the application. The list should be constructed by using the New-MsolServicePrincipalAddress help cmdlet.
  • Field Name: Addresses
  • Type: String
ObjectId The object ID associated with the service principal to retrieve.
  • Field Name: ObjectId
  • Type: String
TrustedForDelegation
  • Field Name: TrustedForDelegation
  • Type: Boolean
ServicePrincipalNames A list of service principal names (SPNs) associated with the service principal. An SPN must be unique per company tenant and is used by an application to uniquely identify itself. By default the service principal AppID is always added as an SPN. An SPN must use one of the following formats "appName" or "appName/hostname" or be a valid URL. AppName represents the name of the application and hostname represents the URI authority for the application. When the service principal represents a WS-Federation relying party, an SPN can be set to a URL that would be treated as the WS-Federation wtrealm parameter.
  • Field Name: ServicePrincipalNames.[n]
  • Type: Array
Value The value of the credential. If the credential type is set to "asymmetric", it represents the base 64 encoded certificate. If the credential type is set to "symmetric" and Value is not set, a 256 bit AES key will be automatically created and valid for one year from creation. If the credential type is set to "password", the Value parameter must be supplied and it should not be base 64 encoded.
  • Field Name: Value
  • Type: String
TenantId The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.
  • Field Name: TenantId
  • Type: String
ExtensionData
  • Field Name: ExtensionData
  • Type: String
Usage The usage of the credential key. The credential key usage can either be set to "sign" or "verify" a token. The default setting is "verify". Sign is allowed ONLY for symmetric keys. Verify is allowed for all key types. A "verify" credential key is required by Windows Azure Active Directory to verify that the request token was sent by your application (represented by this service principal). Your application may optionally require that Windows Azure Active Directory issue tokens to your application signed with your signing key rather than the asymmetric public key identifying Windows Azure Active Directory. In this case, provide a "sign" credential key for your service principal.
  • Field Name: Usage
  • Type: String
AppPrincipalId The unique application identifier for a service principal in a tenant. Once created this property cannot be changed. If an AppPrincipalId is not specified, one will be generated.
  • Field Name: AppPrincipalId
  • Type: String
DisplayName * The friendly name of the service principal
  • Field Name: DisplayName
  • Type: String
Type The type of credential used. The credential type can either be set to "asymmetric", "symmetric" or "password". If "asymmetric", the Value parameter must be set to the public portion of a base 64 encoded X509 certificate. If "symmetric", then a 256 bit AES symmetric key will be generated if Value is not set. If "password", the Value parameter must be supplied and it should not be base 64 encoded. The default setting is "symmetric".
  • Field Name: Type
  • Type: String