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
argumentsArgumentStringHandlerworkingDirectorystringenvironmentVariablesIReadOnlyDictionary<string, string>timeoutint?logOutputbool?logInvocationbool?loggerAction<OutputType, string>exitHandlerAction<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
configuratorCombinatorialConfigure<CloudFoundryApiSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<url>via Url--skip-ssl-validationvia SkipSSLValidation--unsetvia 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
configuratorConfigure<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-validationvia SkipSSLValidation--unsetvia 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
toolSettingsCloudFoundryApiSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<url>via Url--skip-ssl-validationvia SkipSSLValidation--unsetvia 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
configuratorCombinatorialConfigure<CloudFoundryAuthSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<password>via Password<username>via Username--client-credentialsvia ClientCredentials-originvia Origin
CloudFoundryAuth(Configure<CloudFoundryAuthSettings>)
Authenticate non-interactively
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryAuth(Configure<CloudFoundryAuthSettings> configurator)
Parameters
configuratorConfigure<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-credentialsvia ClientCredentials-originvia Origin
CloudFoundryAuth(CloudFoundryAuthSettings)
Authenticate non-interactively
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryAuth(CloudFoundryAuthSettings toolSettings = null)
Parameters
toolSettingsCloudFoundryAuthSettings
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-credentialsvia ClientCredentials-originvia 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
configuratorCombinatorialConfigure<CloudFoundryBindServiceSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName<serviceInstance>via ServiceInstance--binding-namevia BindingName-cvia ConfigurationParameters
CloudFoundryBindService(Configure<CloudFoundryBindServiceSettings>)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryBindService(Configure<CloudFoundryBindServiceSettings> configurator)
Parameters
configuratorConfigure<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-namevia BindingName-cvia ConfigurationParameters
CloudFoundryBindService(CloudFoundryBindServiceSettings)
Bind service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryBindService(CloudFoundryBindServiceSettings toolSettings = null)
Parameters
toolSettingsCloudFoundryBindServiceSettings
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-namevia BindingName-cvia 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
configuratorCombinatorialConfigure<CloudFoundryCreateRouteSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryCreateRouteSettings
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
configuratorCombinatorialConfigure<CloudFoundryCreateServiceSettings>degreeOfParallelismintcompleteOnFailurebool
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-cvia ConfigurationParameters-tvia Tags
CloudFoundryCreateService(Configure<CloudFoundryCreateServiceSettings>)
Create a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateService(Configure<CloudFoundryCreateServiceSettings> configurator)
Parameters
configuratorConfigure<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-cvia ConfigurationParameters-tvia Tags
CloudFoundryCreateService(CloudFoundryCreateServiceSettings)
Create a service instance
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryCreateService(CloudFoundryCreateServiceSettings toolSettings = null)
Parameters
toolSettingsCloudFoundryCreateServiceSettings
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-cvia ConfigurationParameters-tvia 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
configuratorCombinatorialConfigure<CloudFoundryCreateSpaceSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryCreateSpaceSettings
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
configuratorCombinatorialConfigure<CloudFoundryCreateUserProvidedServiceSettings>degreeOfParallelismintcompleteOnFailurebool
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-lvia LogUrl-pvia Credentials-rvia RouteUrl-tvia 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
configuratorConfigure<CloudFoundryCreateUserProvidedServiceSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstanceName>via ServiceInstanceName-lvia LogUrl-pvia Credentials-rvia RouteUrl-tvia 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
toolSettingsCloudFoundryCreateUserProvidedServiceSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<serviceInstanceName>via ServiceInstanceName-lvia LogUrl-pvia Credentials-rvia RouteUrl-tvia 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
configuratorCombinatorialConfigure<CloudFoundryCurlSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>via Path-dvia HttpData-ivia IncludeResponseHeaders-Xvia 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
configuratorConfigure<CloudFoundryCurlSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>via Path-dvia HttpData-ivia IncludeResponseHeaders-Xvia 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
toolSettingsCloudFoundryCurlSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<path>via Path-dvia HttpData-ivia IncludeResponseHeaders-Xvia 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
configuratorCombinatorialConfigure<CloudFoundryDeleteApplicationSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName-rvia DeleteRoutes
CloudFoundryDeleteApplication(Configure<CloudFoundryDeleteApplicationSettings>)
Delete an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteApplication(Configure<CloudFoundryDeleteApplicationSettings> configurator)
Parameters
configuratorConfigure<CloudFoundryDeleteApplicationSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName-rvia DeleteRoutes
CloudFoundryDeleteApplication(CloudFoundryDeleteApplicationSettings)
Delete an app
For more details, visit the official website.
public static IReadOnlyCollection<Output> CloudFoundryDeleteApplication(CloudFoundryDeleteApplicationSettings toolSettings = null)
Parameters
toolSettingsCloudFoundryDeleteApplicationSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName-rvia 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
configuratorCombinatorialConfigure<CloudFoundryDeleteServiceSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryDeleteServiceSettings
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
configuratorCombinatorialConfigure<CloudFoundryDeleteSpaceSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryDeleteSpaceSettings
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
serviceInstancestring
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
configuratorCombinatorialConfigure<CloudFoundryGetServiceInfoSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryGetServiceInfoSettings
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
configuratorCombinatorialConfigure<CloudFoundryLoginSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validationvia SkipSslValidation-avia ApiEndpoint-ovia Org-pvia Password-svia Space-uvia 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
configuratorConfigure<CloudFoundryLoginSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validationvia SkipSslValidation-avia ApiEndpoint-ovia Org-pvia Password-svia Space-uvia 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
toolSettingsCloudFoundryLoginSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
--skip-ssl-validationvia SkipSslValidation-avia ApiEndpoint-ovia Org-pvia Password-svia Space-uvia 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
configuratorCombinatorialConfigure<CloudFoundryMapRouteSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryMapRouteSettings
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
configuratorCombinatorialConfigure<CloudFoundryPushSettings>degreeOfParallelismintcompleteOnFailurebool
Returns
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName--docker-usernamevia DockerUsername--dropletvia Droplet--no-manifestvia IgnoreManifest--no-routevia NoRoute--no-startvia NoStart--random-routevia RandomRoute--route-pathvia RoutePath-bvia Buildpack-cvia Command-dvia Domain-fvia Manifest-nvia Hostname-ovia DockerImage-pvia Path-svia Stack-tvia StartupTimeout-uvia HealthCheckType-varvia Variables-vars-filevia 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
configuratorConfigure<CloudFoundryPushSettings>
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName--docker-usernamevia DockerUsername--dropletvia Droplet--no-manifestvia IgnoreManifest--no-routevia NoRoute--no-startvia NoStart--random-routevia RandomRoute--route-pathvia RoutePath-bvia Buildpack-cvia Command-dvia Domain-fvia Manifest-nvia Hostname-ovia DockerImage-pvia Path-svia Stack-tvia StartupTimeout-uvia HealthCheckType-varvia Variables-vars-filevia 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
toolSettingsCloudFoundryPushSettings
Returns
- IReadOnlyCollection<Output>
Remarks
This is a CLI wrapper with fluent API that allows to modify the following arguments:
<appName>via AppName--docker-usernamevia DockerUsername--dropletvia Droplet--no-manifestvia IgnoreManifest--no-routevia NoRoute--no-startvia NoStart--random-routevia RandomRoute--route-pathvia RoutePath-bvia Buildpack-cvia Command-dvia Domain-fvia Manifest-nvia Hostname-ovia DockerImage-pvia Path-svia Stack-tvia StartupTimeout-uvia HealthCheckType-varvia Variables-vars-filevia 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
configuratorCombinatorialConfigure<CloudFoundryRestageSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryRestageSettings
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
configuratorCombinatorialConfigure<CloudFoundryRestartSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryRestartSettings
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
configuratorCombinatorialConfigure<CloudFoundryScaleSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryScaleSettings
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
configuratorCombinatorialConfigure<CloudFoundrySetEnvSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundrySetEnvSettings
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
configuratorCombinatorialConfigure<CloudFoundryStartSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryStartSettings
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
configuratorCombinatorialConfigure<CloudFoundryStopSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryStopSettings
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
configuratorCombinatorialConfigure<CloudFoundryTargetSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryTargetSettings
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
configuratorCombinatorialConfigure<CloudFoundryUnbindServiceSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryUnbindServiceSettings
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
configuratorCombinatorialConfigure<CloudFoundryUnmapRouteSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryUnmapRouteSettings
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
configuratorCombinatorialConfigure<CloudFoundryUnsetEnvSettings>degreeOfParallelismintcompleteOnFailurebool
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
configuratorConfigure<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
toolSettingsCloudFoundryUnsetEnvSettings
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()