1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. Provider
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.Provider

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    The provider type for the octopusdeploy package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 access_token: Optional[str] = None,
                 address: Optional[str] = None,
                 api_key: Optional[str] = None,
                 space_id: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:octopusdeploy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    AccessToken string
    The OIDC Access Token to use with the Octopus REST API
    Address string
    The endpoint of the Octopus REST API
    ApiKey string
    The API key to use with the Octopus REST API
    SpaceId string
    The space ID to target
    AccessToken string
    The OIDC Access Token to use with the Octopus REST API
    Address string
    The endpoint of the Octopus REST API
    ApiKey string
    The API key to use with the Octopus REST API
    SpaceId string
    The space ID to target
    accessToken String
    The OIDC Access Token to use with the Octopus REST API
    address String
    The endpoint of the Octopus REST API
    apiKey String
    The API key to use with the Octopus REST API
    spaceId String
    The space ID to target
    accessToken string
    The OIDC Access Token to use with the Octopus REST API
    address string
    The endpoint of the Octopus REST API
    apiKey string
    The API key to use with the Octopus REST API
    spaceId string
    The space ID to target
    access_token str
    The OIDC Access Token to use with the Octopus REST API
    address str
    The endpoint of the Octopus REST API
    api_key str
    The API key to use with the Octopus REST API
    space_id str
    The space ID to target
    accessToken String
    The OIDC Access Token to use with the Octopus REST API
    address String
    The endpoint of the Octopus REST API
    apiKey String
    The API key to use with the Octopus REST API
    spaceId String
    The space ID to target

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs