Resource Type: azure_service_principal

Defined in:
lib/puppet/type/azure_service_principal.rb
Providers:
arm

Overview

Active Directory service principal information.

Properties

  • account_enabled

    whether or not the service principal account is enabled

  • alternative_names

    alternative names

  • app_display_name

    The display name exposed by the associated application.

  • app_id

    The application ID.

  • app_owner_tenant_id

    “”

  • app_role_assignment_required

    Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.

  • app_roles

    The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.

  • deletion_timestamp

    The time at which the directory object was deleted.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • error_url

    A URL provided by the author of the associated application to report errors when using the application.

  • homepage

    The URL to the homepage of the associated application.

  • key_credentials

    The collection of key credentials associated with the service principal.

  • logout_url

    A URL provided by the author of the associated application to logout

  • oauth2_permissions

    The OAuth 2.0 permissions exposed by the associated application.

  • object_id

    The object ID.

  • object_type

    The object type.

  • password_credentials

    The collection of password credentials associated with the service principal.

  • preferred_token_signing_key_thumbprint

    The thumbprint of preferred certificate to sign the token

  • publisher_name

    The publisher’s name of the associated application

  • reply_urls

    The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.

  • saml_metadata_url

    The URL to the SAML metadata of the associated application

  • service_principal_names

    A collection of service principal names.

  • service_principal_type

    the type of the service principal

  • tags

    Optional list of tags that you can apply to your service principals. Not nullable.

Parameters

  • api_version

    Client API version.

  • display_name (namevar)

    The display name of the service principal.

  • parameters

    Parameters to create a service principal.

  • provider

    The specific backend to use for this ‘azure_service_principal` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • tenant_id

    The tenant ID.