Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. CheckRestApi
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.CheckRestApi

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages a Rest API check on a resource within Azure DevOps.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = new azuredevops.Project("example", {name: "Example Project"});
const exampleServiceEndpointGeneric = new azuredevops.ServiceEndpointGeneric("example", {
    projectId: example.id,
    serverUrl: "https://some-server.example.com",
    serviceEndpointName: "Example Generic",
    username: "username",
    password: "password",
    description: "Managed by Pulumi",
});
const exampleAzure = new azuredevops.ServiceEndpointGeneric("example_azure", {
    projectId: example.id,
    serverUrl: "https://dev.azure.com/",
    serviceEndpointName: "Example Generic Azure",
    username: "username",
    password: "dummy",
});
const exampleVariableGroup = new azuredevops.VariableGroup("example", {
    projectId: example.id,
    name: "Example Variable Group",
    allowAccess: true,
    variables: [{
        name: "FOO",
        value: "BAR",
    }],
});
const exampleCheckRestApi = new azuredevops.CheckRestApi("example", {
    projectId: example.id,
    targetResourceId: exampleServiceEndpointGeneric.id,
    targetResourceType: "endpoint",
    displayName: "Example REST API Check",
    connectedServiceNameSelector: "connectedServiceName",
    connectedServiceName: exampleAzure.serviceEndpointName,
    method: "POST",
    headers: "{\"contentType\":\"application/json\"}",
    body: "{\"params\":\"value\"}",
    completionEvent: "ApiResponse",
    successCriteria: "eq(root['status'], '200')",
    urlSuffix: "user/1",
    retryInterval: 4000,
    variableGroupName: exampleVariableGroup.name,
    timeout: 40000,
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example", name="Example Project")
example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("example",
    project_id=example.id,
    server_url="https://some-server.example.com",
    service_endpoint_name="Example Generic",
    username="username",
    password="password",
    description="Managed by Pulumi")
example_azure = azuredevops.ServiceEndpointGeneric("example_azure",
    project_id=example.id,
    server_url="https://dev.azure.com/",
    service_endpoint_name="Example Generic Azure",
    username="username",
    password="dummy")
example_variable_group = azuredevops.VariableGroup("example",
    project_id=example.id,
    name="Example Variable Group",
    allow_access=True,
    variables=[{
        "name": "FOO",
        "value": "BAR",
    }])
example_check_rest_api = azuredevops.CheckRestApi("example",
    project_id=example.id,
    target_resource_id=example_service_endpoint_generic.id,
    target_resource_type="endpoint",
    display_name="Example REST API Check",
    connected_service_name_selector="connectedServiceName",
    connected_service_name=example_azure.service_endpoint_name,
    method="POST",
    headers="{\"contentType\":\"application/json\"}",
    body="{\"params\":\"value\"}",
    completion_event="ApiResponse",
    success_criteria="eq(root['status'], '200')",
    url_suffix="user/1",
    retry_interval=4000,
    variable_group_name=example_variable_group.name,
    timeout=40000)

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name: pulumi.String("Example Project"),
		})
		if err != nil {
			return err
		}
		exampleServiceEndpointGeneric, err := azuredevops.NewServiceEndpointGeneric(ctx, "example", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           example.ID(),
			ServerUrl:           pulumi.String("https://some-server.example.com"),
			ServiceEndpointName: pulumi.String("Example Generic"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
			Description:         pulumi.String("Managed by Pulumi"),
		})
		if err != nil {
			return err
		}
		exampleAzure, err := azuredevops.NewServiceEndpointGeneric(ctx, "example_azure", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           example.ID(),
			ServerUrl:           pulumi.String("https://dev.azure.com/"),
			ServiceEndpointName: pulumi.String("Example Generic Azure"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("dummy"),
		})
		if err != nil {
			return err
		}
		exampleVariableGroup, err := azuredevops.NewVariableGroup(ctx, "example", &azuredevops.VariableGroupArgs{
			ProjectId:   example.ID(),
			Name:        pulumi.String("Example Variable Group"),
			AllowAccess: pulumi.Bool(true),
			Variables: azuredevops.VariableGroupVariableArray{
				&azuredevops.VariableGroupVariableArgs{
					Name:  pulumi.String("FOO"),
					Value: pulumi.String("BAR"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewCheckRestApi(ctx, "example", &azuredevops.CheckRestApiArgs{
			ProjectId:                    example.ID(),
			TargetResourceId:             exampleServiceEndpointGeneric.ID(),
			TargetResourceType:           pulumi.String("endpoint"),
			DisplayName:                  pulumi.String("Example REST API Check"),
			ConnectedServiceNameSelector: pulumi.String("connectedServiceName"),
			ConnectedServiceName:         exampleAzure.ServiceEndpointName,
			Method:                       pulumi.String("POST"),
			Headers:                      pulumi.String("{\"contentType\":\"application/json\"}"),
			Body:                         pulumi.String("{\"params\":\"value\"}"),
			CompletionEvent:              pulumi.String("ApiResponse"),
			SuccessCriteria:              pulumi.String("eq(root['status'], '200')"),
			UrlSuffix:                    pulumi.String("user/1"),
			RetryInterval:                pulumi.Int(4000),
			VariableGroupName:            exampleVariableGroup.Name,
			Timeout:                      pulumi.Int(40000),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
    });

    var exampleServiceEndpointGeneric = new AzureDevOps.ServiceEndpointGeneric("example", new()
    {
        ProjectId = example.Id,
        ServerUrl = "https://some-server.example.com",
        ServiceEndpointName = "Example Generic",
        Username = "username",
        Password = "password",
        Description = "Managed by Pulumi",
    });

    var exampleAzure = new AzureDevOps.ServiceEndpointGeneric("example_azure", new()
    {
        ProjectId = example.Id,
        ServerUrl = "https://dev.azure.com/",
        ServiceEndpointName = "Example Generic Azure",
        Username = "username",
        Password = "dummy",
    });

    var exampleVariableGroup = new AzureDevOps.VariableGroup("example", new()
    {
        ProjectId = example.Id,
        Name = "Example Variable Group",
        AllowAccess = true,
        Variables = new[]
        {
            new AzureDevOps.Inputs.VariableGroupVariableArgs
            {
                Name = "FOO",
                Value = "BAR",
            },
        },
    });

    var exampleCheckRestApi = new AzureDevOps.CheckRestApi("example", new()
    {
        ProjectId = example.Id,
        TargetResourceId = exampleServiceEndpointGeneric.Id,
        TargetResourceType = "endpoint",
        DisplayName = "Example REST API Check",
        ConnectedServiceNameSelector = "connectedServiceName",
        ConnectedServiceName = exampleAzure.ServiceEndpointName,
        Method = "POST",
        Headers = "{\"contentType\":\"application/json\"}",
        Body = "{\"params\":\"value\"}",
        CompletionEvent = "ApiResponse",
        SuccessCriteria = "eq(root['status'], '200')",
        UrlSuffix = "user/1",
        RetryInterval = 4000,
        VariableGroupName = exampleVariableGroup.Name,
        Timeout = 40000,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointGeneric;
import com.pulumi.azuredevops.ServiceEndpointGenericArgs;
import com.pulumi.azuredevops.VariableGroup;
import com.pulumi.azuredevops.VariableGroupArgs;
import com.pulumi.azuredevops.inputs.VariableGroupVariableArgs;
import com.pulumi.azuredevops.CheckRestApi;
import com.pulumi.azuredevops.CheckRestApiArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .build());

        var exampleServiceEndpointGeneric = new ServiceEndpointGeneric("exampleServiceEndpointGeneric", ServiceEndpointGenericArgs.builder()
            .projectId(example.id())
            .serverUrl("https://some-server.example.com")
            .serviceEndpointName("Example Generic")
            .username("username")
            .password("password")
            .description("Managed by Pulumi")
            .build());

        var exampleAzure = new ServiceEndpointGeneric("exampleAzure", ServiceEndpointGenericArgs.builder()
            .projectId(example.id())
            .serverUrl("https://dev.azure.com/")
            .serviceEndpointName("Example Generic Azure")
            .username("username")
            .password("dummy")
            .build());

        var exampleVariableGroup = new VariableGroup("exampleVariableGroup", VariableGroupArgs.builder()
            .projectId(example.id())
            .name("Example Variable Group")
            .allowAccess(true)
            .variables(VariableGroupVariableArgs.builder()
                .name("FOO")
                .value("BAR")
                .build())
            .build());

        var exampleCheckRestApi = new CheckRestApi("exampleCheckRestApi", CheckRestApiArgs.builder()
            .projectId(example.id())
            .targetResourceId(exampleServiceEndpointGeneric.id())
            .targetResourceType("endpoint")
            .displayName("Example REST API Check")
            .connectedServiceNameSelector("connectedServiceName")
            .connectedServiceName(exampleAzure.serviceEndpointName())
            .method("POST")
            .headers("{\"contentType\":\"application/json\"}")
            .body("{\"params\":\"value\"}")
            .completionEvent("ApiResponse")
            .successCriteria("eq(root['status'], '200')")
            .urlSuffix("user/1")
            .retryInterval(4000)
            .variableGroupName(exampleVariableGroup.name())
            .timeout("40000")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
  exampleServiceEndpointGeneric:
    type: azuredevops:ServiceEndpointGeneric
    name: example
    properties:
      projectId: ${example.id}
      serverUrl: https://some-server.example.com
      serviceEndpointName: Example Generic
      username: username
      password: password
      description: Managed by Pulumi
  exampleAzure:
    type: azuredevops:ServiceEndpointGeneric
    name: example_azure
    properties:
      projectId: ${example.id}
      serverUrl: https://dev.azure.com/
      serviceEndpointName: Example Generic Azure
      username: username
      password: dummy
  exampleVariableGroup:
    type: azuredevops:VariableGroup
    name: example
    properties:
      projectId: ${example.id}
      name: Example Variable Group
      allowAccess: true
      variables:
        - name: FOO
          value: BAR
  exampleCheckRestApi:
    type: azuredevops:CheckRestApi
    name: example
    properties:
      projectId: ${example.id}
      targetResourceId: ${exampleServiceEndpointGeneric.id}
      targetResourceType: endpoint
      displayName: Example REST API Check
      connectedServiceNameSelector: connectedServiceName
      connectedServiceName: ${exampleAzure.serviceEndpointName}
      method: POST
      headers: '{"contentType":"application/json"}'
      body: '{"params":"value"}'
      completionEvent: ApiResponse
      successCriteria: eq(root['status'], '200')
      urlSuffix: user/1
      retryInterval: 4000
      variableGroupName: ${exampleVariableGroup.name}
      timeout: '40000'

    Create CheckRestApi Resource

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

    Constructor syntax

    new CheckRestApi(name: string, args: CheckRestApiArgs, opts?: CustomResourceOptions);
    @overload
def CheckRestApi(resource_name: str,
                 args: CheckRestApiArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def CheckRestApi(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 method: Optional[str] = None,
                 target_resource_id: Optional[str] = None,
                 connected_service_name: Optional[str] = None,
                 connected_service_name_selector: Optional[str] = None,
                 display_name: Optional[str] = None,
                 target_resource_type: Optional[str] = None,
                 project_id: Optional[str] = None,
                 retry_interval: Optional[int] = None,
                 body: Optional[str] = None,
                 success_criteria: Optional[str] = None,
                 completion_event: Optional[str] = None,
                 headers: Optional[str] = None,
                 timeout: Optional[int] = None,
                 url_suffix: Optional[str] = None,
                 variable_group_name: Optional[str] = None)
    func NewCheckRestApi(ctx *Context, name string, args CheckRestApiArgs, opts ...ResourceOption) (*CheckRestApi, error)
    public CheckRestApi(string name, CheckRestApiArgs args, CustomResourceOptions? opts = null)
    public CheckRestApi(String name, CheckRestApiArgs args)
public CheckRestApi(String name, CheckRestApiArgs args, CustomResourceOptions options)

    type: azuredevops:CheckRestApi
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 CheckRestApiArgs
    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 CheckRestApiArgs
    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 CheckRestApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CheckRestApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CheckRestApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var checkRestApiResource = new AzureDevOps.CheckRestApi("checkRestApiResource", new()
{
    Method = "string",
    TargetResourceId = "string",
    ConnectedServiceName = "string",
    ConnectedServiceNameSelector = "string",
    DisplayName = "string",
    TargetResourceType = "string",
    ProjectId = "string",
    RetryInterval = 0,
    Body = "string",
    SuccessCriteria = "string",
    CompletionEvent = "string",
    Headers = "string",
    Timeout = 0,
    UrlSuffix = "string",
    VariableGroupName = "string",
});

    example, err := azuredevops.NewCheckRestApi(ctx, "checkRestApiResource", &azuredevops.CheckRestApiArgs{
	Method:                       pulumi.String("string"),
	TargetResourceId:             pulumi.String("string"),
	ConnectedServiceName:         pulumi.String("string"),
	ConnectedServiceNameSelector: pulumi.String("string"),
	DisplayName:                  pulumi.String("string"),
	TargetResourceType:           pulumi.String("string"),
	ProjectId:                    pulumi.String("string"),
	RetryInterval:                pulumi.Int(0),
	Body:                         pulumi.String("string"),
	SuccessCriteria:              pulumi.String("string"),
	CompletionEvent:              pulumi.String("string"),
	Headers:                      pulumi.String("string"),
	Timeout:                      pulumi.Int(0),
	UrlSuffix:                    pulumi.String("string"),
	VariableGroupName:            pulumi.String("string"),
})

    var checkRestApiResource = new CheckRestApi("checkRestApiResource", CheckRestApiArgs.builder()
    .method("string")
    .targetResourceId("string")
    .connectedServiceName("string")
    .connectedServiceNameSelector("string")
    .displayName("string")
    .targetResourceType("string")
    .projectId("string")
    .retryInterval(0)
    .body("string")
    .successCriteria("string")
    .completionEvent("string")
    .headers("string")
    .timeout(0)
    .urlSuffix("string")
    .variableGroupName("string")
    .build());

    check_rest_api_resource = azuredevops.CheckRestApi("checkRestApiResource",
    method="string",
    target_resource_id="string",
    connected_service_name="string",
    connected_service_name_selector="string",
    display_name="string",
    target_resource_type="string",
    project_id="string",
    retry_interval=0,
    body="string",
    success_criteria="string",
    completion_event="string",
    headers="string",
    timeout=0,
    url_suffix="string",
    variable_group_name="string")

    const checkRestApiResource = new azuredevops.CheckRestApi("checkRestApiResource", {
    method: "string",
    targetResourceId: "string",
    connectedServiceName: "string",
    connectedServiceNameSelector: "string",
    displayName: "string",
    targetResourceType: "string",
    projectId: "string",
    retryInterval: 0,
    body: "string",
    successCriteria: "string",
    completionEvent: "string",
    headers: "string",
    timeout: 0,
    urlSuffix: "string",
    variableGroupName: "string",
});

    type: azuredevops:CheckRestApi
properties:
    body: string
    completionEvent: string
    connectedServiceName: string
    connectedServiceNameSelector: string
    displayName: string
    headers: string
    method: string
    projectId: string
    retryInterval: 0
    successCriteria: string
    targetResourceId: string
    targetResourceType: string
    timeout: 0
    urlSuffix: string
    variableGroupName: string

    CheckRestApi 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 CheckRestApi resource accepts the following input properties:

    ConnectedServiceName string
    The name of the Service Connection.
    ConnectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    DisplayName string
    The Name of the Rest API check.
    Method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    ProjectId string
    The ID of the project. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    TargetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    Body string
    The Rest API request body.
    CompletionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    Headers string
    The headers of the request in JSON format.
    RetryInterval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    SuccessCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    Timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    UrlSuffix string
    The URL suffix and parameters.
    VariableGroupName string
    The name of the Variable Group.
    ConnectedServiceName string
    The name of the Service Connection.
    ConnectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    DisplayName string
    The Name of the Rest API check.
    Method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    ProjectId string
    The ID of the project. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    TargetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    Body string
    The Rest API request body.
    CompletionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    Headers string
    The headers of the request in JSON format.
    RetryInterval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    SuccessCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    Timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    UrlSuffix string
    The URL suffix and parameters.
    VariableGroupName string
    The name of the Variable Group.
    connectedServiceName String
    The name of the Service Connection.
    connectedServiceNameSelector String
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName String
    The Name of the Rest API check.
    method String
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId String
    The ID of the project. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType String
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    body String
    The Rest API request body.
    completionEvent String
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    headers String
    The headers of the request in JSON format.
    retryInterval Integer

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria String

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    timeout Integer
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix String
    The URL suffix and parameters.
    variableGroupName String
    The name of the Variable Group.
    connectedServiceName string
    The name of the Service Connection.
    connectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName string
    The Name of the Rest API check.
    method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId string
    The ID of the project. Changing this forces a new resource to be created.
    targetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    body string
    The Rest API request body.
    completionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    headers string
    The headers of the request in JSON format.
    retryInterval number

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    timeout number
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix string
    The URL suffix and parameters.
    variableGroupName string
    The name of the Variable Group.
    connected_service_name str
    The name of the Service Connection.
    connected_service_name_selector str
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    display_name str
    The Name of the Rest API check.
    method str
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    project_id str
    The ID of the project. Changing this forces a new resource to be created.
    target_resource_id str
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    target_resource_type str
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    body str
    The Rest API request body.
    completion_event str
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    headers str
    The headers of the request in JSON format.
    retry_interval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    success_criteria str

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    url_suffix str
    The URL suffix and parameters.
    variable_group_name str
    The name of the Variable Group.
    connectedServiceName String
    The name of the Service Connection.
    connectedServiceNameSelector String
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName String
    The Name of the Rest API check.
    method String
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId String
    The ID of the project. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType String
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    body String
    The Rest API request body.
    completionEvent String
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    headers String
    The headers of the request in JSON format.
    retryInterval Number

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria String

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    timeout Number
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix String
    The URL suffix and parameters.
    variableGroupName String
    The name of the Variable Group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Rest API check.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Rest API check.
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the Rest API check.
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the Rest API check.
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the Rest API check.
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the Rest API check.

    Look up Existing CheckRestApi Resource

    Get an existing CheckRestApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CheckRestApiState, opts?: CustomResourceOptions): CheckRestApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        completion_event: Optional[str] = None,
        connected_service_name: Optional[str] = None,
        connected_service_name_selector: Optional[str] = None,
        display_name: Optional[str] = None,
        headers: Optional[str] = None,
        method: Optional[str] = None,
        project_id: Optional[str] = None,
        retry_interval: Optional[int] = None,
        success_criteria: Optional[str] = None,
        target_resource_id: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        timeout: Optional[int] = None,
        url_suffix: Optional[str] = None,
        variable_group_name: Optional[str] = None,
        version: Optional[int] = None) -> CheckRestApi
    func GetCheckRestApi(ctx *Context, name string, id IDInput, state *CheckRestApiState, opts ...ResourceOption) (*CheckRestApi, error)
    public static CheckRestApi Get(string name, Input<string> id, CheckRestApiState? state, CustomResourceOptions? opts = null)
    public static CheckRestApi get(String name, Output<String> id, CheckRestApiState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:CheckRestApi    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Body string
    The Rest API request body.
    CompletionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    ConnectedServiceName string
    The name of the Service Connection.
    ConnectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    DisplayName string
    The Name of the Rest API check.
    Headers string
    The headers of the request in JSON format.
    Method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    ProjectId string
    The ID of the project. Changing this forces a new resource to be created.
    RetryInterval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    SuccessCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    TargetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    Timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    UrlSuffix string
    The URL suffix and parameters.
    VariableGroupName string
    The name of the Variable Group.
    Version int
    The version of the Rest API check.
    Body string
    The Rest API request body.
    CompletionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    ConnectedServiceName string
    The name of the Service Connection.
    ConnectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    DisplayName string
    The Name of the Rest API check.
    Headers string
    The headers of the request in JSON format.
    Method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    ProjectId string
    The ID of the project. Changing this forces a new resource to be created.
    RetryInterval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    SuccessCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    TargetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    Timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    UrlSuffix string
    The URL suffix and parameters.
    VariableGroupName string
    The name of the Variable Group.
    Version int
    The version of the Rest API check.
    body String
    The Rest API request body.
    completionEvent String
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    connectedServiceName String
    The name of the Service Connection.
    connectedServiceNameSelector String
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName String
    The Name of the Rest API check.
    headers String
    The headers of the request in JSON format.
    method String
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId String
    The ID of the project. Changing this forces a new resource to be created.
    retryInterval Integer

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria String

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType String
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    timeout Integer
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix String
    The URL suffix and parameters.
    variableGroupName String
    The name of the Variable Group.
    version Integer
    The version of the Rest API check.
    body string
    The Rest API request body.
    completionEvent string
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    connectedServiceName string
    The name of the Service Connection.
    connectedServiceNameSelector string
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName string
    The Name of the Rest API check.
    headers string
    The headers of the request in JSON format.
    method string
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId string
    The ID of the project. Changing this forces a new resource to be created.
    retryInterval number

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria string

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    targetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType string
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    timeout number
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix string
    The URL suffix and parameters.
    variableGroupName string
    The name of the Variable Group.
    version number
    The version of the Rest API check.
    body str
    The Rest API request body.
    completion_event str
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    connected_service_name str
    The name of the Service Connection.
    connected_service_name_selector str
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    display_name str
    The Name of the Rest API check.
    headers str
    The headers of the request in JSON format.
    method str
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    project_id str
    The ID of the project. Changing this forces a new resource to be created.
    retry_interval int

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    success_criteria str

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    target_resource_id str
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    target_resource_type str
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    timeout int
    The timeout in minutes for the Rest API check. Defaults to 1440.
    url_suffix str
    The URL suffix and parameters.
    variable_group_name str
    The name of the Variable Group.
    version int
    The version of the Rest API check.
    body String
    The Rest API request body.
    completionEvent String
    The completion event of the Rest API call. Possible values: Callback, ApiResponse. Defaults to Callback.
    connectedServiceName String
    The name of the Service Connection.
    connectedServiceNameSelector String
    The type of the Service Connection used to invoke the REST API. Possible values: connectedServiceName(Generic type service connection) and connectedServiceNameARM(Azure Resource Manager type service connection).
    displayName String
    The Name of the Rest API check.
    headers String
    The headers of the request in JSON format.
    method String
    The HTTP method of the request. Possible values: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH
    projectId String
    The ID of the project. Changing this forces a new resource to be created.
    retryInterval Number

    The time between evaluations (minutes).

    ~>NOTE 1. The retry times should less them 10 based on the timeout. For example: timeout is 4000 then retry_interval should be 0 or no less then 400. 2. retry_interval is not required when completion_event=Callback.

    successCriteria String

    The Criteria which defines when to pass the task. No criteria means response content does not influence the result.

    ~>NOTE success_criteria is used when completion_event=ApiResponse

    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new resource to be created
    targetResourceType String
    The type of resource being protected by the check. Possible values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new resource to be created.
    timeout Number
    The timeout in minutes for the Rest API check. Defaults to 1440.
    urlSuffix String
    The URL suffix and parameters.
    variableGroupName String
    The name of the Variable Group.
    version Number
    The version of the Rest API check.

    Import

    Importing this resource is not supported.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
    pulumi/pulumi-azuredevops