Class CloudFoundryTasks
- Namespace
- Nuke.Common.Tools.CloudFoundry
- Assembly
- Nuke.Common.dll
Cloud Foundry CLI is the official command line client for Cloud Foundry
For more details, visit the official website.
public static class CloudFoundryTasks
- Inheritance
-
CloudFoundryTasks
- Inherited Members
Properties
CloudFoundryExitHandler
public static Action<ToolSettings, IProcess> CloudFoundryExitHandler { get; set; }
Property Value
- Action<ToolSettings, IProcess>
CloudFoundryLogger
public static Action<OutputType, string> CloudFoundryLogger { get; set; }
Property Value
CloudFoundryPath
Path to the CloudFoundry executable.
public static string CloudFoundryPath { get; }
Property Value
Methods
CloudFoundry(ArgumentStringHandler, string, IReadOnlyDictionary<string, string>, int?, bool?, bool?, Action<OutputType, string>, Action<IProcess>)
Cloud Foundry CLI is the official command line client for Cloud Foundry
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundry(ArgumentStringHandler arguments, string workingDirectory = null, IReadOnlyDictionary<string, string> environmentVariables = null, int? timeout = null, bool? logOutput = null, bool? logInvocation = null, Action<OutputType, string> logger = null, Action<IProcess> exitHandler = null)
Parameters
arguments
ArgumentStringHandlerworkingDirectory
stringenvironmentVariables
IReadOnlyDictionary<string, string>timeout
int?logOutput
bool?logInvocation
bool?logger
Action<OutputType, string>exitHandler
Action<IProcess>
Returns
- IReadOnlyCollection<Output>
CloudFoundryApi(CombinatorialConfigure<CloudFoundryApiSettings>, int, bool)
Set or view target api url
For more details, visit the official website.
public static IEnumerable<(CloudFoundryApiSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryApi(CombinatorialConfigure<CloudFoundryApiSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryApiSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<url>
via Url--skip-ssl-validation
via SkipSSLValidation--unset
via Unset
CloudFoundryApi(Configure<CloudFoundryApiSettings>)
Set or view target api url
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryApi(Configure<CloudFoundryApiSettings> configurator)
Parameters
configurator
Configure<CloudFoundryApiSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<url>
via Url--skip-ssl-validation
via SkipSSLValidation--unset
via Unset
CloudFoundryApi(CloudFoundryApiSettings)
Set or view target api url
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryApi(CloudFoundryApiSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryApiSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<url>
via Url--skip-ssl-validation
via SkipSSLValidation--unset
via Unset
CloudFoundryAuth(CombinatorialConfigure<CloudFoundryAuthSettings>, int, bool)
Authenticate non-interactively
For more details, visit the official website.
public static IEnumerable<(CloudFoundryAuthSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryAuth(CombinatorialConfigure<CloudFoundryAuthSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryAuthSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<password>
via Password<username>
via Username--client-credentials
via ClientCredentials-origin
via Origin
CloudFoundryAuth(Configure<CloudFoundryAuthSettings>)
Authenticate non-interactively
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryAuth(Configure<CloudFoundryAuthSettings> configurator)
Parameters
configurator
Configure<CloudFoundryAuthSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<password>
via Password<username>
via Username--client-credentials
via ClientCredentials-origin
via Origin
CloudFoundryAuth(CloudFoundryAuthSettings)
Authenticate non-interactively
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryAuth(CloudFoundryAuthSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryAuthSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<password>
via Password<username>
via Username--client-credentials
via ClientCredentials-origin
via Origin
CloudFoundryBindService(CombinatorialConfigure<CloudFoundryBindServiceSettings>, int, bool)
Bind service instance
For more details, visit the official website.
public static IEnumerable<(CloudFoundryBindServiceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryBindService(CombinatorialConfigure<CloudFoundryBindServiceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryBindServiceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance--binding-name
via BindingName-c
via ConfigurationParameters
CloudFoundryBindService(Configure<CloudFoundryBindServiceSettings>)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryBindService(Configure<CloudFoundryBindServiceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryBindServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance--binding-name
via BindingName-c
via ConfigurationParameters
CloudFoundryBindService(CloudFoundryBindServiceSettings)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryBindService(CloudFoundryBindServiceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryBindServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance--binding-name
via BindingName-c
via ConfigurationParameters
CloudFoundryCreateRoute(CombinatorialConfigure<CloudFoundryCreateRouteSettings>, int, bool)
Create a url route in a space for later use
For more details, visit the official website.
public static IEnumerable<(CloudFoundryCreateRouteSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryCreateRoute(CombinatorialConfigure<CloudFoundryCreateRouteSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryCreateRouteSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateRoute(Configure<CloudFoundryCreateRouteSettings>)
Create a url route in a space for later use
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateRoute(Configure<CloudFoundryCreateRouteSettings> configurator)
Parameters
configurator
Configure<CloudFoundryCreateRouteSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateRoute(CloudFoundryCreateRouteSettings)
Create a url route in a space for later use
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateRoute(CloudFoundryCreateRouteSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryCreateRouteSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateService(CombinatorialConfigure<CloudFoundryCreateServiceSettings>, int, bool)
Create a service instance
For more details, visit the official website.
public static IEnumerable<(CloudFoundryCreateServiceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryCreateService(CombinatorialConfigure<CloudFoundryCreateServiceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryCreateServiceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<instanceName>
via InstanceName<plan>
via Plan<service>
via Service-c
via ConfigurationParameters-t
via Tags
CloudFoundryCreateService(Configure<CloudFoundryCreateServiceSettings>)
Create a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateService(Configure<CloudFoundryCreateServiceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryCreateServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<instanceName>
via InstanceName<plan>
via Plan<service>
via Service-c
via ConfigurationParameters-t
via Tags
CloudFoundryCreateService(CloudFoundryCreateServiceSettings)
Create a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateService(CloudFoundryCreateServiceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryCreateServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<instanceName>
via InstanceName<plan>
via Plan<service>
via Service-c
via ConfigurationParameters-t
via Tags
CloudFoundryCreateSpace(CombinatorialConfigure<CloudFoundryCreateSpaceSettings>, int, bool)
Create a space
For more details, visit the official website.
public static IEnumerable<(CloudFoundryCreateSpaceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryCreateSpace(CombinatorialConfigure<CloudFoundryCreateSpaceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryCreateSpaceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateSpace(Configure<CloudFoundryCreateSpaceSettings>)
Create a space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateSpace(Configure<CloudFoundryCreateSpaceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryCreateSpaceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateSpace(CloudFoundryCreateSpaceSettings)
Create a space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateSpace(CloudFoundryCreateSpaceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryCreateSpaceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryCreateUserProvidedService(CombinatorialConfigure<CloudFoundryCreateUserProvidedServiceSettings>, int, bool)
Make a user-provided service instance available to CF apps
For more details, visit the official website.
public static IEnumerable<(CloudFoundryCreateUserProvidedServiceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryCreateUserProvidedService(CombinatorialConfigure<CloudFoundryCreateUserProvidedServiceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryCreateUserProvidedServiceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
- IEnumerable<(CloudFoundryCreateUserProvidedServiceSettings Settings, IReadOnlyCollection<Output> Output)>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstanceName>
via ServiceInstanceName-l
via LogUrl-p
via Credentials-r
via RouteUrl-t
via Tags
CloudFoundryCreateUserProvidedService(Configure<CloudFoundryCreateUserProvidedServiceSettings>)
Make a user-provided service instance available to CF apps
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateUserProvidedService(Configure<CloudFoundryCreateUserProvidedServiceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryCreateUserProvidedServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstanceName>
via ServiceInstanceName-l
via LogUrl-p
via Credentials-r
via RouteUrl-t
via Tags
CloudFoundryCreateUserProvidedService(CloudFoundryCreateUserProvidedServiceSettings)
Make a user-provided service instance available to CF apps
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateUserProvidedService(CloudFoundryCreateUserProvidedServiceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryCreateUserProvidedServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstanceName>
via ServiceInstanceName-l
via LogUrl-p
via Credentials-r
via RouteUrl-t
via Tags
CloudFoundryCurl(CombinatorialConfigure<CloudFoundryCurlSettings>, int, bool)
Executes a request to the targeted API endpoint
For more details, visit the official website.
public static IEnumerable<(CloudFoundryCurlSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryCurl(CombinatorialConfigure<CloudFoundryCurlSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryCurlSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>
via Path-d
via HttpData-i
via IncludeResponseHeaders-X
via HttpMethod
CloudFoundryCurl(Configure<CloudFoundryCurlSettings>)
Executes a request to the targeted API endpoint
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCurl(Configure<CloudFoundryCurlSettings> configurator)
Parameters
configurator
Configure<CloudFoundryCurlSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>
via Path-d
via HttpData-i
via IncludeResponseHeaders-X
via HttpMethod
CloudFoundryCurl(CloudFoundryCurlSettings)
Executes a request to the targeted API endpoint
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCurl(CloudFoundryCurlSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryCurlSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>
via Path-d
via HttpData-i
via IncludeResponseHeaders-X
via HttpMethod
CloudFoundryDeleteApplication(CombinatorialConfigure<CloudFoundryDeleteApplicationSettings>, int, bool)
Delete an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryDeleteApplicationSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryDeleteApplication(CombinatorialConfigure<CloudFoundryDeleteApplicationSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryDeleteApplicationSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName-r
via DeleteRoutes
CloudFoundryDeleteApplication(Configure<CloudFoundryDeleteApplicationSettings>)
Delete an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteApplication(Configure<CloudFoundryDeleteApplicationSettings> configurator)
Parameters
configurator
Configure<CloudFoundryDeleteApplicationSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName-r
via DeleteRoutes
CloudFoundryDeleteApplication(CloudFoundryDeleteApplicationSettings)
Delete an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteApplication(CloudFoundryDeleteApplicationSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryDeleteApplicationSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName-r
via DeleteRoutes
CloudFoundryDeleteService(CombinatorialConfigure<CloudFoundryDeleteServiceSettings>, int, bool)
Delete a service instance
For more details, visit the official website.
public static IEnumerable<(CloudFoundryDeleteServiceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryDeleteService(CombinatorialConfigure<CloudFoundryDeleteServiceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryDeleteServiceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryDeleteService(Configure<CloudFoundryDeleteServiceSettings>)
Delete a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteService(Configure<CloudFoundryDeleteServiceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryDeleteServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryDeleteService(CloudFoundryDeleteServiceSettings)
Delete a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteService(CloudFoundryDeleteServiceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryDeleteServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryDeleteSpace(CombinatorialConfigure<CloudFoundryDeleteSpaceSettings>, int, bool)
Delete a space
For more details, visit the official website.
public static IEnumerable<(CloudFoundryDeleteSpaceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryDeleteSpace(CombinatorialConfigure<CloudFoundryDeleteSpaceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryDeleteSpaceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryDeleteSpace(Configure<CloudFoundryDeleteSpaceSettings>)
Delete a space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteSpace(Configure<CloudFoundryDeleteSpaceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryDeleteSpaceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryDeleteSpace(CloudFoundryDeleteSpaceSettings)
Delete a space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteSpace(CloudFoundryDeleteSpaceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryDeleteSpaceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryEnsureServiceReady(string)
Create task which will complete when creation of an asynchronous service is complete. This uses polling to query it repeatedly
public static Task CloudFoundryEnsureServiceReady(string serviceInstance)
Parameters
serviceInstance
string
Returns
CloudFoundryEnsureServiceReady(string, TimeSpan)
Create task which will complete when creation of an asynchronous service is complete. This uses polling to query it repeatedly
public static Task CloudFoundryEnsureServiceReady(string serviceInstance, TimeSpan checkInterval)
Parameters
Returns
CloudFoundryGetServiceInfo(CombinatorialConfigure<CloudFoundryGetServiceInfoSettings>, int, bool)
Show service instance info
For more details, visit the official website.
public static IEnumerable<(CloudFoundryGetServiceInfoSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryGetServiceInfo(CombinatorialConfigure<CloudFoundryGetServiceInfoSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryGetServiceInfoSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryGetServiceInfo(Configure<CloudFoundryGetServiceInfoSettings>)
Show service instance info
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryGetServiceInfo(Configure<CloudFoundryGetServiceInfoSettings> configurator)
Parameters
configurator
Configure<CloudFoundryGetServiceInfoSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryGetServiceInfo(CloudFoundryGetServiceInfoSettings)
Show service instance info
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryGetServiceInfo(CloudFoundryGetServiceInfoSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryGetServiceInfoSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstance>
via ServiceInstance
CloudFoundryLogin(CombinatorialConfigure<CloudFoundryLoginSettings>, int, bool)
Log user in to specific endpoint and optionally set target
For more details, visit the official website.
public static IEnumerable<(CloudFoundryLoginSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryLogin(CombinatorialConfigure<CloudFoundryLoginSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryLoginSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validation
via SkipSslValidation-a
via ApiEndpoint-o
via Org-p
via Password-s
via Space-u
via Username
CloudFoundryLogin(Configure<CloudFoundryLoginSettings>)
Log user in to specific endpoint and optionally set target
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryLogin(Configure<CloudFoundryLoginSettings> configurator)
Parameters
configurator
Configure<CloudFoundryLoginSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validation
via SkipSslValidation-a
via ApiEndpoint-o
via Org-p
via Password-s
via Space-u
via Username
CloudFoundryLogin(CloudFoundryLoginSettings)
Log user in to specific endpoint and optionally set target
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryLogin(CloudFoundryLoginSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryLoginSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validation
via SkipSslValidation-a
via ApiEndpoint-o
via Org-p
via Password-s
via Space-u
via Username
CloudFoundryMapRoute(CombinatorialConfigure<CloudFoundryMapRouteSettings>, int, bool)
Add a url route to an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryMapRouteSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryMapRoute(CombinatorialConfigure<CloudFoundryMapRouteSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryMapRouteSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryMapRoute(Configure<CloudFoundryMapRouteSettings>)
Add a url route to an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryMapRoute(Configure<CloudFoundryMapRouteSettings> configurator)
Parameters
configurator
Configure<CloudFoundryMapRouteSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryMapRoute(CloudFoundryMapRouteSettings)
Add a url route to an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryMapRoute(CloudFoundryMapRouteSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryMapRouteSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryPush(CombinatorialConfigure<CloudFoundryPushSettings>, int, bool)
Push a new app or sync changes to an existing app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryPushSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryPush(CombinatorialConfigure<CloudFoundryPushSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryPushSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName--docker-username
via DockerUsername--droplet
via Droplet--no-manifest
via IgnoreManifest--no-route
via NoRoute--no-start
via NoStart--random-route
via RandomRoute--route-path
via RoutePath-b
via Buildpack-c
via Command-d
via Domain-f
via Manifest-n
via Hostname-o
via DockerImage-p
via Path-s
via Stack-t
via StartupTimeout-u
via HealthCheckType-var
via Variables-vars-file
via VariablesFile
CloudFoundryPush(Configure<CloudFoundryPushSettings>)
Push a new app or sync changes to an existing app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryPush(Configure<CloudFoundryPushSettings> configurator)
Parameters
configurator
Configure<CloudFoundryPushSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName--docker-username
via DockerUsername--droplet
via Droplet--no-manifest
via IgnoreManifest--no-route
via NoRoute--no-start
via NoStart--random-route
via RandomRoute--route-path
via RoutePath-b
via Buildpack-c
via Command-d
via Domain-f
via Manifest-n
via Hostname-o
via DockerImage-p
via Path-s
via Stack-t
via StartupTimeout-u
via HealthCheckType-var
via Variables-vars-file
via VariablesFile
CloudFoundryPush(CloudFoundryPushSettings)
Push a new app or sync changes to an existing app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryPush(CloudFoundryPushSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryPushSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName--docker-username
via DockerUsername--droplet
via Droplet--no-manifest
via IgnoreManifest--no-route
via NoRoute--no-start
via NoStart--random-route
via RandomRoute--route-path
via RoutePath-b
via Buildpack-c
via Command-d
via Domain-f
via Manifest-n
via Hostname-o
via DockerImage-p
via Path-s
via Stack-t
via StartupTimeout-u
via HealthCheckType-var
via Variables-vars-file
via VariablesFile
CloudFoundryRestage(CombinatorialConfigure<CloudFoundryRestageSettings>, int, bool)
Recreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.). This action will cause app downtime.
For more details, visit the official website.
public static IEnumerable<(CloudFoundryRestageSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryRestage(CombinatorialConfigure<CloudFoundryRestageSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryRestageSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryRestage(Configure<CloudFoundryRestageSettings>)
Recreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.). This action will cause app downtime.
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryRestage(Configure<CloudFoundryRestageSettings> configurator)
Parameters
configurator
Configure<CloudFoundryRestageSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryRestage(CloudFoundryRestageSettings)
Recreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.). This action will cause app downtime.
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryRestage(CloudFoundryRestageSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryRestageSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryRestart(CombinatorialConfigure<CloudFoundryRestartSettings>, int, bool)
Stop all instances of the app, then start them again. This causes downtime.
For more details, visit the official website.
public static IEnumerable<(CloudFoundryRestartSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryRestart(CombinatorialConfigure<CloudFoundryRestartSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryRestartSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryRestart(Configure<CloudFoundryRestartSettings>)
Stop all instances of the app, then start them again. This causes downtime.
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryRestart(Configure<CloudFoundryRestartSettings> configurator)
Parameters
configurator
Configure<CloudFoundryRestartSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryRestart(CloudFoundryRestartSettings)
Stop all instances of the app, then start them again. This causes downtime.
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryRestart(CloudFoundryRestartSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryRestartSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryScale(CombinatorialConfigure<CloudFoundryScaleSettings>, int, bool)
Change or view the instance count, disk space limit, and memory limit for an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryScaleSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryScale(CombinatorialConfigure<CloudFoundryScaleSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryScaleSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryScale(Configure<CloudFoundryScaleSettings>)
Change or view the instance count, disk space limit, and memory limit for an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryScale(Configure<CloudFoundryScaleSettings> configurator)
Parameters
configurator
Configure<CloudFoundryScaleSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryScale(CloudFoundryScaleSettings)
Change or view the instance count, disk space limit, and memory limit for an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryScale(CloudFoundryScaleSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryScaleSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundrySetEnv(CombinatorialConfigure<CloudFoundrySetEnvSettings>, int, bool)
Set an env variable for an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundrySetEnvSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundrySetEnv(CombinatorialConfigure<CloudFoundrySetEnvSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundrySetEnvSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<envVarName>
via EnvVarName<envVarValue>
via EnvVarValue
CloudFoundrySetEnv(Configure<CloudFoundrySetEnvSettings>)
Set an env variable for an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundrySetEnv(Configure<CloudFoundrySetEnvSettings> configurator)
Parameters
configurator
Configure<CloudFoundrySetEnvSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<envVarName>
via EnvVarName<envVarValue>
via EnvVarValue
CloudFoundrySetEnv(CloudFoundrySetEnvSettings)
Set an env variable for an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundrySetEnv(CloudFoundrySetEnvSettings toolSettings = null)
Parameters
toolSettings
CloudFoundrySetEnvSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<envVarName>
via EnvVarName<envVarValue>
via EnvVarValue
CloudFoundryStart(CombinatorialConfigure<CloudFoundryStartSettings>, int, bool)
Start an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryStartSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryStart(CombinatorialConfigure<CloudFoundryStartSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryStartSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryStart(Configure<CloudFoundryStartSettings>)
Start an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryStart(Configure<CloudFoundryStartSettings> configurator)
Parameters
configurator
Configure<CloudFoundryStartSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryStart(CloudFoundryStartSettings)
Start an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryStart(CloudFoundryStartSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryStartSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryStop(CombinatorialConfigure<CloudFoundryStopSettings>, int, bool)
Stop an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryStopSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryStop(CombinatorialConfigure<CloudFoundryStopSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryStopSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryStop(Configure<CloudFoundryStopSettings>)
Stop an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryStop(Configure<CloudFoundryStopSettings> configurator)
Parameters
configurator
Configure<CloudFoundryStopSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryStop(CloudFoundryStopSettings)
Stop an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryStop(CloudFoundryStopSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryStopSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName
CloudFoundryTarget(CombinatorialConfigure<CloudFoundryTargetSettings>, int, bool)
Set or view the targeted org or space
For more details, visit the official website.
public static IEnumerable<(CloudFoundryTargetSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryTarget(CombinatorialConfigure<CloudFoundryTargetSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryTargetSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryTarget(Configure<CloudFoundryTargetSettings>)
Set or view the targeted org or space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryTarget(Configure<CloudFoundryTargetSettings> configurator)
Parameters
configurator
Configure<CloudFoundryTargetSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryTarget(CloudFoundryTargetSettings)
Set or view the targeted org or space
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryTarget(CloudFoundryTargetSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryTargetSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryUnbindService(CombinatorialConfigure<CloudFoundryUnbindServiceSettings>, int, bool)
Bind service instance
For more details, visit the official website.
public static IEnumerable<(CloudFoundryUnbindServiceSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryUnbindService(CombinatorialConfigure<CloudFoundryUnbindServiceSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryUnbindServiceSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance
CloudFoundryUnbindService(Configure<CloudFoundryUnbindServiceSettings>)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnbindService(Configure<CloudFoundryUnbindServiceSettings> configurator)
Parameters
configurator
Configure<CloudFoundryUnbindServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance
CloudFoundryUnbindService(CloudFoundryUnbindServiceSettings)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnbindService(CloudFoundryUnbindServiceSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryUnbindServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<serviceInstance>
via ServiceInstance
CloudFoundryUnmapRoute(CombinatorialConfigure<CloudFoundryUnmapRouteSettings>, int, bool)
Remove a url route from an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryUnmapRouteSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryUnmapRoute(CombinatorialConfigure<CloudFoundryUnmapRouteSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryUnmapRouteSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryUnmapRoute(Configure<CloudFoundryUnmapRouteSettings>)
Remove a url route from an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnmapRoute(Configure<CloudFoundryUnmapRouteSettings> configurator)
Parameters
configurator
Configure<CloudFoundryUnmapRouteSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryUnmapRoute(CloudFoundryUnmapRouteSettings)
Remove a url route from an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnmapRoute(CloudFoundryUnmapRouteSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryUnmapRouteSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
CloudFoundryUnsetEnv(CombinatorialConfigure<CloudFoundryUnsetEnvSettings>, int, bool)
Remove an env variable from an app
For more details, visit the official website.
public static IEnumerable<(CloudFoundryUnsetEnvSettings Settings, IReadOnlyCollection<Output> Output)> CloudFoundryUnsetEnv(CombinatorialConfigure<CloudFoundryUnsetEnvSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false)
Parameters
configurator
CombinatorialConfigure<CloudFoundryUnsetEnvSettings>degreeOfParallelism
intcompleteOnFailure
bool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<environmentalVariableName>
via EnvironmentalVariableName
CloudFoundryUnsetEnv(Configure<CloudFoundryUnsetEnvSettings>)
Remove an env variable from an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnsetEnv(Configure<CloudFoundryUnsetEnvSettings> configurator)
Parameters
configurator
Configure<CloudFoundryUnsetEnvSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<environmentalVariableName>
via EnvironmentalVariableName
CloudFoundryUnsetEnv(CloudFoundryUnsetEnvSettings)
Remove an env variable from an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryUnsetEnv(CloudFoundryUnsetEnvSettings toolSettings = null)
Parameters
toolSettings
CloudFoundryUnsetEnvSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>
via AppName<environmentalVariableName>
via EnvironmentalVariableName
GetToolPath()
public static string GetToolPath()