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

octopusdeploy.getMachinePolicies

Explore with Pulumi AI

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

    Provides information about existing machine policies.

    Using getMachinePolicies

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMachinePolicies(args: GetMachinePoliciesArgs, opts?: InvokeOptions): Promise<GetMachinePoliciesResult>
    function getMachinePoliciesOutput(args: GetMachinePoliciesOutputArgs, opts?: InvokeOptions): Output<GetMachinePoliciesResult>
    def get_machine_policies(id: Optional[str] = None,
                             ids: Optional[Sequence[str]] = None,
                             partial_name: Optional[str] = None,
                             skip: Optional[float] = None,
                             space_id: Optional[str] = None,
                             take: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetMachinePoliciesResult
    def get_machine_policies_output(id: Optional[pulumi.Input[str]] = None,
                             ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             partial_name: Optional[pulumi.Input[str]] = None,
                             skip: Optional[pulumi.Input[float]] = None,
                             space_id: Optional[pulumi.Input[str]] = None,
                             take: Optional[pulumi.Input[float]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetMachinePoliciesResult]
    func GetMachinePolicies(ctx *Context, args *GetMachinePoliciesArgs, opts ...InvokeOption) (*GetMachinePoliciesResult, error)
    func GetMachinePoliciesOutput(ctx *Context, args *GetMachinePoliciesOutputArgs, opts ...InvokeOption) GetMachinePoliciesResultOutput

    > Note: This function is named GetMachinePolicies in the Go SDK.

    public static class GetMachinePolicies 
    {
        public static Task<GetMachinePoliciesResult> InvokeAsync(GetMachinePoliciesArgs args, InvokeOptions? opts = null)
        public static Output<GetMachinePoliciesResult> Invoke(GetMachinePoliciesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMachinePoliciesResult> getMachinePolicies(GetMachinePoliciesArgs args, InvokeOptions options)
    public static Output<GetMachinePoliciesResult> getMachinePolicies(GetMachinePoliciesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: octopusdeploy:index/getMachinePolicies:getMachinePolicies
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this resource.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    The ID of this resource.
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this resource.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this resource.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    The ID of this resource.
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by the partial match of a name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    The space ID associated with this resource.
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    The ID of this resource.
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by the partial match of a name.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    The space ID associated with this resource.
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this resource.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getMachinePolicies Result

    The following output properties are available:

    Id string
    The ID of this resource.
    MachinePolicies List<GetMachinePoliciesMachinePolicy>
    A list of machine policies that match the filter(s).
    SpaceId string
    The space ID associated with this resource.
    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    Skip double
    A filter to specify the number of items to skip in the response.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    The ID of this resource.
    MachinePolicies []GetMachinePoliciesMachinePolicy
    A list of machine policies that match the filter(s).
    SpaceId string
    The space ID associated with this resource.
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    machinePolicies List<GetMachinePoliciesMachinePolicy>
    A list of machine policies that match the filter(s).
    spaceId String
    The space ID associated with this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    skip Double
    A filter to specify the number of items to skip in the response.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    The ID of this resource.
    machinePolicies GetMachinePoliciesMachinePolicy[]
    A list of machine policies that match the filter(s).
    spaceId string
    The space ID associated with this resource.
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by the partial match of a name.
    skip number
    A filter to specify the number of items to skip in the response.
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    The ID of this resource.
    machine_policies Sequence[GetMachinePoliciesMachinePolicy]
    A list of machine policies that match the filter(s).
    space_id str
    The space ID associated with this resource.
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by the partial match of a name.
    skip float
    A filter to specify the number of items to skip in the response.
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    machinePolicies List<Property Map>
    A list of machine policies that match the filter(s).
    spaceId String
    The space ID associated with this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    skip Number
    A filter to specify the number of items to skip in the response.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetMachinePoliciesMachinePolicy

    GetMachinePoliciesMachinePolicyMachineCleanupPolicy

    GetMachinePoliciesMachinePolicyMachineConnectivityPolicy

    GetMachinePoliciesMachinePolicyMachineHealthCheckPolicy

    GetMachinePoliciesMachinePolicyMachineHealthCheckPolicyBashHealthCheckPolicy

    RunType string
    ScriptBody string
    RunType string
    ScriptBody string
    runType String
    scriptBody String
    runType string
    scriptBody string
    runType String
    scriptBody String

    GetMachinePoliciesMachinePolicyMachineHealthCheckPolicyPowershellHealthCheckPolicy

    RunType string
    ScriptBody string
    RunType string
    ScriptBody string
    runType String
    scriptBody String
    runType string
    scriptBody string
    runType String
    scriptBody String

    GetMachinePoliciesMachinePolicyMachineUpdatePolicy

    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