Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
203 lines (180 sloc) 10.9 KB
<Type Name="SpnEndpointIdentity" FullName="System.ServiceModel.SpnEndpointIdentity">
<TypeSignature Language="C#" Value="public class SpnEndpointIdentity : System.ServiceModel.EndpointIdentity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SpnEndpointIdentity extends System.ServiceModel.EndpointIdentity" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.SpnEndpointIdentity" />
<TypeSignature Language="VB.NET" Value="Public Class SpnEndpointIdentity&#xA;Inherits EndpointIdentity" />
<TypeSignature Language="C++ CLI" Value="public ref class SpnEndpointIdentity : System::ServiceModel::EndpointIdentity" />
<TypeSignature Language="F#" Value="type SpnEndpointIdentity = class&#xA; inherit EndpointIdentity" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Security</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.5.0.1</AssemblyVersion>
<AssemblyVersion>4.5.0.3</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ServiceModel.EndpointIdentity</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a service principal name (SPN) for an identity when the binding uses Kerberos.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An SPN is the name by which a client uniquely identifies an instance of a service. If you install multiple instances of a service on computers throughout a forest, each instance must have its own SPN. A given service instance can have multiple SPNs if there are multiple names that clients might use for authentication.
When a client wants to connect to a service, it locates an instance of the service, composes an SPN for that instance, and sets the identity to a <xref:System.ServiceModel.SpnEndpointIdentity>. A check will be made that the message is intended for that service.
The three authentication modes used under Kerberos are:
- SSPINegotiate
- Kerberos
- KerberosOverTransport.
## Examples
The following code shows one common way to create an instance of this class.
[!code-csharp[S_UESpnEndpointIdentity#1](~/samples/snippets/csharp/VS_Snippets_CFX/s_uespnendpointidentity/cs/service.cs#1)]
[!code-vb[S_UESpnEndpointIdentity#1](~/samples/snippets/visualbasic/VS_Snippets_CFX/s_uespnendpointidentity/vb/service.vb#1)]
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of <see cref="T:System.ServiceModel.SpnEndpointIdentity" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpnEndpointIdentity (System.IdentityModel.Claims.Claim identity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IdentityModel.Claims.Claim identity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.SpnEndpointIdentity.#ctor(System.IdentityModel.Claims.Claim)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (identity As Claim)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; SpnEndpointIdentity(System::IdentityModel::Claims::Claim ^ identity);" />
<MemberSignature Language="F#" Value="new System.ServiceModel.SpnEndpointIdentity : System.IdentityModel.Claims.Claim -&gt; System.ServiceModel.SpnEndpointIdentity" Usage="new System.ServiceModel.SpnEndpointIdentity identity" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Security</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="identity" Type="System.IdentityModel.Claims.Claim" Index="0" FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="identity">The identity for this service principal name (SPN).</param>
<summary>Initializes a new instance of <see cref="T:System.ServiceModel.SpnEndpointIdentity" /> with the specified identity claim.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor sets the <xref:System.ServiceModel.SpnEndpointIdentity.SpnLookupTime%2A> property to 1 minute.
## Examples
The following code shows how to create identities from a set of claims.
[!code-csharp[S_UESpnEndpointIdentity#2](~/samples/snippets/csharp/VS_Snippets_CFX/s_uespnendpointidentity/cs/service.cs#2)]
[!code-vb[S_UESpnEndpointIdentity#2](~/samples/snippets/visualbasic/VS_Snippets_CFX/s_uespnendpointidentity/vb/service.vb#2)]
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="identity" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The claim type of <paramref name="identity" /> is not <see cref="P:System.IdentityModel.Claims.ClaimTypes.Spn" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpnEndpointIdentity (string spnName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string spnName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.SpnEndpointIdentity.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (spnName As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; SpnEndpointIdentity(System::String ^ spnName);" />
<MemberSignature Language="F#" Value="new System.ServiceModel.SpnEndpointIdentity : string -&gt; System.ServiceModel.SpnEndpointIdentity" Usage="new System.ServiceModel.SpnEndpointIdentity spnName" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Security</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.5.0.1</AssemblyVersion>
<AssemblyVersion>4.5.0.3</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="spnName" Type="System.String" />
</Parameters>
<Docs>
<param name="spnName">The SPN.</param>
<summary>Initializes a new instance of <see cref="T:System.ServiceModel.SpnEndpointIdentity" /> with the specified service principal name (SPN).</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor sets the <xref:System.ServiceModel.SpnEndpointIdentity.SpnLookupTime%2A> property to 1 minute.
## Examples
The following code shows how to create identities from a string representation of the SPN.
[!code-csharp[S_UESpnEndpointIdentity#3](~/samples/snippets/csharp/VS_Snippets_CFX/s_uespnendpointidentity/cs/service.cs#3)]
[!code-vb[S_UESpnEndpointIdentity#3](~/samples/snippets/visualbasic/VS_Snippets_CFX/s_uespnendpointidentity/vb/service.vb#3)]
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="spnName" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="SpnLookupTime">
<MemberSignature Language="C#" Value="public static TimeSpan SpnLookupTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype System.TimeSpan SpnLookupTime" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.SpnEndpointIdentity.SpnLookupTime" />
<MemberSignature Language="VB.NET" Value="Public Shared Property SpnLookupTime As TimeSpan" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property TimeSpan SpnLookupTime { TimeSpan get(); void set(TimeSpan value); };" />
<MemberSignature Language="F#" Value="member this.SpnLookupTime : TimeSpan with get, set" Usage="System.ServiceModel.SpnEndpointIdentity.SpnLookupTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Security</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.5.0.1</AssemblyVersion>
<AssemblyVersion>4.5.0.3</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies the maximum time allowed to look up the service principal name (SPN).</summary>
<value>A <see cref="T:System.TimeSpan" />. The default is 1 minute.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value is set to less than 0.</exception>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.