Smart​Card​Provisioning Smart​Card​Provisioning Smart​Card​Provisioning Class

Definition

Represents info about, and operations for, configuring smart cards.

public : sealed class SmartCardProvisioning : ISmartCardProvisioning, ISmartCardProvisioning2public sealed class SmartCardProvisioning : ISmartCardProvisioning, ISmartCardProvisioning2Public NotInheritable Class SmartCardProvisioning Implements ISmartCardProvisioning, ISmartCardProvisioning2
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

SmartCard SmartCard SmartCard

Gets the configured smart card.

public : SmartCard SmartCard { get; }public SmartCard SmartCard { get; }Public ReadOnly Property SmartCard As SmartCard
Value
SmartCard SmartCard SmartCard

The configured smart card.

Attributes
See Also

Methods

FromSmartCardAsync(SmartCard) FromSmartCardAsync(SmartCard) FromSmartCardAsync(SmartCard)

Returns a smart card to be configured.

public : static IAsyncOperation<SmartCardProvisioning> FromSmartCardAsync(SmartCard card)public static IAsyncOperation<SmartCardProvisioning> FromSmartCardAsync(SmartCard card)Public Static Function FromSmartCardAsync(card As SmartCard) As IAsyncOperation( Of SmartCardProvisioning )
Parameters
card
SmartCard SmartCard SmartCard

The specified smart card.

Returns
Attributes
See Also

GetAuthorityKeyContainerNameAsync() GetAuthorityKeyContainerNameAsync() GetAuthorityKeyContainerNameAsync()

Asynchronously gets the name of the authority key container.

public : IAsyncOperation<PlatForm::String> GetAuthorityKeyContainerNameAsync()public IAsyncOperation<string> GetAuthorityKeyContainerNameAsync()Public Function GetAuthorityKeyContainerNameAsync() As IAsyncOperation( Of string )
Returns
IAsyncOperation<PlatForm::String> IAsyncOperation<string> IAsyncOperation<string>

An async operation that provides access to a string containing the name of the authority key container.

Attributes
See Also

GetChallengeContextAsync() GetChallengeContextAsync() GetChallengeContextAsync()

Returns a smart card's authentication challenge/response context.

public : IAsyncOperation<SmartCardChallengeContext> GetChallengeContextAsync()public IAsyncOperation<SmartCardChallengeContext> GetChallengeContextAsync()Public Function GetChallengeContextAsync() As IAsyncOperation( Of SmartCardChallengeContext )
Returns

After the asynchronous operation completes, returns an instance of SmartCardChalllengeContext, representing the smart card's authentication challenge/response context.

Attributes
See Also

GetIdAsync() GetIdAsync() GetIdAsync()

Returns the smart card's ID.

public : IAsyncOperation<PlatForm::Guid> GetIdAsync()public IAsyncOperation<Guid> GetIdAsync()Public Function GetIdAsync() As IAsyncOperation( Of Guid )
Returns
IAsyncOperation<PlatForm::Guid> IAsyncOperation<Guid> IAsyncOperation<Guid>

After the asynchronous operation completes, returns the smart card's ID.

Attributes
See Also

GetNameAsync() GetNameAsync() GetNameAsync()

Returns the smart card's minidriver name.

public : IAsyncOperation<PlatForm::String> GetNameAsync()public IAsyncOperation<string> GetNameAsync()Public Function GetNameAsync() As IAsyncOperation( Of string )
Returns
IAsyncOperation<PlatForm::String> IAsyncOperation<string> IAsyncOperation<string>

After the asynchronous operation completes, returns the smart card's name.

Attributes
See Also

RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy) RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy) RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)

Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters.

public : static IAsyncOperation<SmartCardProvisioning> RequestAttestedVirtualSmartCardCreationAsync(PlatForm::String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy)public static IAsyncOperation<SmartCardProvisioning> RequestAttestedVirtualSmartCardCreationAsync(String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy)Public Static Function RequestAttestedVirtualSmartCardCreationAsync(friendlyName As String, administrativeKey As IBuffer, pinPolicy As SmartCardPinPolicy) As IAsyncOperation( Of SmartCardProvisioning )
Parameters
friendlyName
PlatForm::String String String

The smart card's human-readable name.

administrativeKey
IBuffer IBuffer IBuffer

The smart card's admin key (also known as an administrator PIN or unblock PIN).

pinPolicy
SmartCardPinPolicy SmartCardPinPolicy SmartCardPinPolicy

The smart card's PIN rules set.

Returns

After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid) RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid) RequestAttestedVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)

Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters.

public : static IAsyncOperation<SmartCardProvisioning> RequestAttestedVirtualSmartCardCreationAsync(PlatForm::String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy, PlatForm::Guid cardId)public static IAsyncOperation<SmartCardProvisioning> RequestAttestedVirtualSmartCardCreationAsync(String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy, Guid cardId)Public Static Function RequestAttestedVirtualSmartCardCreationAsync(friendlyName As String, administrativeKey As IBuffer, pinPolicy As SmartCardPinPolicy, cardId As Guid) As IAsyncOperation( Of SmartCardProvisioning )
Parameters
friendlyName
PlatForm::String String String

The smart card's human-readable name.

administrativeKey
IBuffer IBuffer IBuffer

The smart card's admin key (also known as an administrator PIN or unblock PIN).

pinPolicy
SmartCardPinPolicy SmartCardPinPolicy SmartCardPinPolicy

The smart card's PIN rules set.

cardId
PlatForm::Guid Guid Guid

The smart card's ID.

Returns

After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestPinChangeAsync() RequestPinChangeAsync() RequestPinChangeAsync()

Changes a smart card's personal identification number (PIN).

public : IAsyncOperation<PlatForm::Boolean> RequestPinChangeAsync()public IAsyncOperation<bool> RequestPinChangeAsync()Public Function RequestPinChangeAsync() As IAsyncOperation( Of bool )
Returns
IAsyncOperation<PlatForm::Boolean> IAsyncOperation<bool> IAsyncOperation<bool>

After the smart card PIN change attempt completes, returns true if the smart card's PIN was successfully changed; otherwise false.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestPinResetAsync(SmartCardPinResetHandler) RequestPinResetAsync(SmartCardPinResetHandler) RequestPinResetAsync(SmartCardPinResetHandler)

Resets a smart card's personal identification number (PIN).

public : IAsyncOperation<PlatForm::Boolean> RequestPinResetAsync(SmartCardPinResetHandler handler)public IAsyncOperation<bool> RequestPinResetAsync(SmartCardPinResetHandler handler)Public Function RequestPinResetAsync(handler As SmartCardPinResetHandler) As IAsyncOperation( Of bool )
Parameters
handler
SmartCardPinResetHandler SmartCardPinResetHandler SmartCardPinResetHandler

The method that handles the smart card PIN reset.

Returns
IAsyncOperation<PlatForm::Boolean> IAsyncOperation<bool> IAsyncOperation<bool>

After the smart card PIN reset attempt completes, returns true if the smart card's PIN was successfully reset; otherwise false.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy) RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy) RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy)

Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, and personal identification number (PIN) rules set.

public : static IAsyncOperation<SmartCardProvisioning> RequestVirtualSmartCardCreationAsync(PlatForm::String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy)public static IAsyncOperation<SmartCardProvisioning> RequestVirtualSmartCardCreationAsync(String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy)Public Static Function RequestVirtualSmartCardCreationAsync(friendlyName As String, administrativeKey As IBuffer, pinPolicy As SmartCardPinPolicy) As IAsyncOperation( Of SmartCardProvisioning )
Parameters
friendlyName
PlatForm::String String String

The smart card's human-readable name.

administrativeKey
IBuffer IBuffer IBuffer

The smart card's admin key (also known as an administrator PIN or unblock PIN).

pinPolicy
SmartCardPinPolicy SmartCardPinPolicy SmartCardPinPolicy

The smart card's PIN rules set.

Returns

After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid) RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid) RequestVirtualSmartCardCreationAsync(String, IBuffer, SmartCardPinPolicy, Guid)

Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, personal identification number (PIN) rules set, and ID.

public : static IAsyncOperation<SmartCardProvisioning> RequestVirtualSmartCardCreationAsync(PlatForm::String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy, PlatForm::Guid cardId)public static IAsyncOperation<SmartCardProvisioning> RequestVirtualSmartCardCreationAsync(String friendlyName, IBuffer administrativeKey, SmartCardPinPolicy pinPolicy, Guid cardId)Public Static Function RequestVirtualSmartCardCreationAsync(friendlyName As String, administrativeKey As IBuffer, pinPolicy As SmartCardPinPolicy, cardId As Guid) As IAsyncOperation( Of SmartCardProvisioning )
Parameters
friendlyName
PlatForm::String String String

The smart card's human-readable name.

administrativeKey
IBuffer IBuffer IBuffer

The smart card's admin key (also known as an administrator PIN or unblock PIN).

pinPolicy
SmartCardPinPolicy SmartCardPinPolicy SmartCardPinPolicy

The smart card's PIN rules set.

cardId
PlatForm::Guid Guid Guid

The smart card's ID.

Returns

After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Attributes

Remarks

When this method is called, it displays a UI to get the PIN from the user.

See Also

RequestVirtualSmartCardDeletionAsync(SmartCard) RequestVirtualSmartCardDeletionAsync(SmartCard) RequestVirtualSmartCardDeletionAsync(SmartCard)

Deletes a Trusted Platform Module (TPM) virtual smart card.

public : static IAsyncOperation<PlatForm::Boolean> RequestVirtualSmartCardDeletionAsync(SmartCard card)public static IAsyncOperation<bool> RequestVirtualSmartCardDeletionAsync(SmartCard card)Public Static Function RequestVirtualSmartCardDeletionAsync(card As SmartCard) As IAsyncOperation( Of bool )
Parameters
card
SmartCard SmartCard SmartCard

The TPM virtual smart card to delete.

Returns
IAsyncOperation<PlatForm::Boolean> IAsyncOperation<bool> IAsyncOperation<bool>

After the deletion attempt completes, returns true if the TPM virtual smart card was successfully deleted; otherwise false.

Attributes

Remarks

When this method is called, it displays a UI to enable the user to consent to the deletion.

See Also

See Also