C# Класс Octopus.Client.OctopusServerEndpoint

Specifies the location and credentials to use when communicating with an Octopus Deploy server.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
AsUser ( string newUserApiKey ) : OctopusServerEndpoint

Recreates the endpoint using the API key of a new user.

OctopusServerEndpoint ( ILinkResolver octopusServer, string apiKey, ICredentials credentials ) : System

Initializes a new instance of the OctopusServerEndpoint class.

OctopusServerEndpoint ( string octopusServerAddress ) : System

Initializes a new instance of the OctopusServerEndpoint class. Since no API key is provided, only very limited functionality will be available.

OctopusServerEndpoint ( string octopusServerAddress, string apiKey ) : System

Initializes a new instance of the OctopusServerEndpoint class.

OctopusServerEndpoint ( string octopusServerAddress, string apiKey, ICredentials credentials ) : System

Initializes a new instance of the OctopusServerEndpoint class.

Описание методов

AsUser() публичный Метод

Recreates the endpoint using the API key of a new user.
public AsUser ( string newUserApiKey ) : OctopusServerEndpoint
newUserApiKey string The new user API key.
Результат OctopusServerEndpoint

OctopusServerEndpoint() публичный Метод

Initializes a new instance of the OctopusServerEndpoint class.
public OctopusServerEndpoint ( ILinkResolver octopusServer, string apiKey, ICredentials credentials ) : System
octopusServer ILinkResolver The resolver that should be used to turn relative links into full URIs.
apiKey string /// The API key to use when connecting to the Octopus server. For more information on API keys, please /// see the API documentation on authentication /// (https://github.com/OctopusDeploy/OctopusDeploy-Api/blob/master/sections/authentication.md). ///
credentials ICredentials /// Additional credentials to use when communicating to servers that require integrated/basic /// authentication. ///
Результат System

OctopusServerEndpoint() публичный Метод

Initializes a new instance of the OctopusServerEndpoint class. Since no API key is provided, only very limited functionality will be available.
public OctopusServerEndpoint ( string octopusServerAddress ) : System
octopusServerAddress string /// The URI of the Octopus Server. Ideally this should end with /api. If it ends with any other segment, the /// client /// will assume Octopus runs under a virtual directory. ///
Результат System

OctopusServerEndpoint() публичный Метод

Initializes a new instance of the OctopusServerEndpoint class.
public OctopusServerEndpoint ( string octopusServerAddress, string apiKey ) : System
octopusServerAddress string /// The URI of the Octopus Server. Ideally this should end with /api. If it ends with any other segment, the /// client /// will assume Octopus runs under a virtual directory. ///
apiKey string /// The API key to use when connecting to the Octopus server. For more information on API keys, please /// see the API documentation on authentication /// (https://github.com/OctopusDeploy/OctopusDeploy-Api/blob/master/sections/authentication.md). ///
Результат System

OctopusServerEndpoint() публичный Метод

Initializes a new instance of the OctopusServerEndpoint class.
public OctopusServerEndpoint ( string octopusServerAddress, string apiKey, ICredentials credentials ) : System
octopusServerAddress string /// The URI of the Octopus Server. Ideally this should end with /api. If it ends with any other segment, the /// client /// will assume Octopus runs under a virtual directory. ///
apiKey string /// The API key to use when connecting to the Octopus server. For more information on API keys, please /// see the API documentation on authentication /// (https://github.com/OctopusDeploy/OctopusDeploy-Api/blob/master/sections/authentication.md). ///
credentials ICredentials /// Additional credentials to use when communicating to servers that require integrated/basic /// authentication. ///
Результат System