Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. deploymentmanager
  5. getStep
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.deploymentmanager.getStep

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    The resource representation of a rollout step. API Version: 2019-11-01-preview.

    Using getStep

    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 getStep(args: GetStepArgs, opts?: InvokeOptions): Promise<GetStepResult>
function getStepOutput(args: GetStepOutputArgs, opts?: InvokeOptions): Output<GetStepResult>
    def get_step(resource_group_name: Optional[str] = None,
             step_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetStepResult
def get_step_output(resource_group_name: Optional[pulumi.Input[str]] = None,
             step_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetStepResult]
    func LookupStep(ctx *Context, args *LookupStepArgs, opts ...InvokeOption) (*LookupStepResult, error)
func LookupStepOutput(ctx *Context, args *LookupStepOutputArgs, opts ...InvokeOption) LookupStepResultOutput

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

    public static class GetStep 
{
    public static Task<GetStepResult> InvokeAsync(GetStepArgs args, InvokeOptions? opts = null)
    public static Output<GetStepResult> Invoke(GetStepInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStepResult> getStep(GetStepArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:deploymentmanager:getStep
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StepName string
    The name of the deployment step.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StepName string
    The name of the deployment step.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    stepName String
    The name of the deployment step.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    stepName string
    The name of the deployment step.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    step_name str
    The name of the deployment step.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    stepName String
    The name of the deployment step.

    getStep Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.DeploymentManager.Outputs.HealthCheckStepPropertiesResponse | Pulumi.AzureNative.DeploymentManager.Outputs.WaitStepPropertiesResponse
    The properties that define the step.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties HealthCheckStepPropertiesResponse | WaitStepPropertiesResponse
    The properties that define the step.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties HealthCheckStepPropertiesResponse | WaitStepPropertiesResponse
    The properties that define the step.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties HealthCheckStepPropertiesResponse | WaitStepPropertiesResponse
    The properties that define the step.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties HealthCheckStepPropertiesResponse | WaitStepPropertiesResponse
    The properties that define the step.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map | Property Map
    The properties that define the step.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    ApiKeyAuthenticationResponse

    In string
    The location of the authentication key/value pair in the request.
    Name string
    The key name of the authentication key/value pair.
    Value string
    The value of the authentication key/value pair.
    In string
    The location of the authentication key/value pair in the request.
    Name string
    The key name of the authentication key/value pair.
    Value string
    The value of the authentication key/value pair.
    in String
    The location of the authentication key/value pair in the request.
    name String
    The key name of the authentication key/value pair.
    value String
    The value of the authentication key/value pair.
    in string
    The location of the authentication key/value pair in the request.
    name string
    The key name of the authentication key/value pair.
    value string
    The value of the authentication key/value pair.
    in_ str
    The location of the authentication key/value pair in the request.
    name str
    The key name of the authentication key/value pair.
    value str
    The value of the authentication key/value pair.
    in String
    The location of the authentication key/value pair in the request.
    name String
    The key name of the authentication key/value pair.
    value String
    The value of the authentication key/value pair.

    HealthCheckStepPropertiesResponse

    Attributes RestHealthCheckStepAttributesResponse
    The health check step attributes
    attributes RestHealthCheckStepAttributesResponse
    The health check step attributes
    attributes RestHealthCheckStepAttributesResponse
    The health check step attributes
    attributes RestHealthCheckStepAttributesResponse
    The health check step attributes
    attributes Property Map
    The health check step attributes

    RestHealthCheckResponse

    Name string
    A unique name for this check.
    Request Pulumi.AzureNative.DeploymentManager.Inputs.RestRequestResponse
    The request to the health provider.
    Response Pulumi.AzureNative.DeploymentManager.Inputs.RestResponseResponse
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
    Name string
    A unique name for this check.
    Request RestRequestResponse
    The request to the health provider.
    Response RestResponseResponse
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
    name String
    A unique name for this check.
    request RestRequestResponse
    The request to the health provider.
    response RestResponseResponse
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
    name string
    A unique name for this check.
    request RestRequestResponse
    The request to the health provider.
    response RestResponseResponse
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
    name str
    A unique name for this check.
    request RestRequestResponse
    The request to the health provider.
    response RestResponseResponse
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.
    name String
    A unique name for this check.
    request Property Map
    The request to the health provider.
    response Property Map
    The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.

    RestHealthCheckStepAttributesResponse

    HealthChecks List<Pulumi.AzureNative.DeploymentManager.Inputs.RestHealthCheckResponse>
    The list of checks that form the health check step.
    HealthyStateDuration string
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    MaxElasticDuration string
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    WaitDuration string
    The duration in ISO 8601 format for which health check waits idly without any checks.
    HealthChecks []RestHealthCheckResponse
    The list of checks that form the health check step.
    HealthyStateDuration string
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    MaxElasticDuration string
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    WaitDuration string
    The duration in ISO 8601 format for which health check waits idly without any checks.
    healthChecks List<RestHealthCheckResponse>
    The list of checks that form the health check step.
    healthyStateDuration String
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    maxElasticDuration String
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    waitDuration String
    The duration in ISO 8601 format for which health check waits idly without any checks.
    healthChecks RestHealthCheckResponse[]
    The list of checks that form the health check step.
    healthyStateDuration string
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    maxElasticDuration string
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    waitDuration string
    The duration in ISO 8601 format for which health check waits idly without any checks.
    health_checks Sequence[RestHealthCheckResponse]
    The list of checks that form the health check step.
    healthy_state_duration str
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    max_elastic_duration str
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    wait_duration str
    The duration in ISO 8601 format for which health check waits idly without any checks.
    healthChecks List<Property Map>
    The list of checks that form the health check step.
    healthyStateDuration String
    The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.
    maxElasticDuration String
    The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.
    waitDuration String
    The duration in ISO 8601 format for which health check waits idly without any checks.

    RestRequestResponse

    Authentication Pulumi.AzureNative.DeploymentManager.Inputs.ApiKeyAuthenticationResponse | Pulumi.AzureNative.DeploymentManager.Inputs.RolloutIdentityAuthenticationResponse
    The authentication information required in the request to the health provider.
    Method string
    The HTTP method to use for the request.
    Uri string
    The HTTP URI to use for the request.
    Authentication ApiKeyAuthenticationResponse | RolloutIdentityAuthenticationResponse
    The authentication information required in the request to the health provider.
    Method string
    The HTTP method to use for the request.
    Uri string
    The HTTP URI to use for the request.
    authentication ApiKeyAuthenticationResponse | RolloutIdentityAuthenticationResponse
    The authentication information required in the request to the health provider.
    method String
    The HTTP method to use for the request.
    uri String
    The HTTP URI to use for the request.
    authentication ApiKeyAuthenticationResponse | RolloutIdentityAuthenticationResponse
    The authentication information required in the request to the health provider.
    method string
    The HTTP method to use for the request.
    uri string
    The HTTP URI to use for the request.
    authentication ApiKeyAuthenticationResponse | RolloutIdentityAuthenticationResponse
    The authentication information required in the request to the health provider.
    method str
    The HTTP method to use for the request.
    uri str
    The HTTP URI to use for the request.
    authentication Property Map | Property Map
    The authentication information required in the request to the health provider.
    method String
    The HTTP method to use for the request.
    uri String
    The HTTP URI to use for the request.

    RestResponseResponse

    Regex Pulumi.AzureNative.DeploymentManager.Inputs.RestResponseResponseRegex
    The regular expressions to match the response content with.
    SuccessStatusCodes List<string>
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
    Regex RestResponseResponseRegex
    The regular expressions to match the response content with.
    SuccessStatusCodes []string
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
    regex RestResponseResponseRegex
    The regular expressions to match the response content with.
    successStatusCodes List<String>
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
    regex RestResponseResponseRegex
    The regular expressions to match the response content with.
    successStatusCodes string[]
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
    regex RestResponseResponseRegex
    The regular expressions to match the response content with.
    success_status_codes Sequence[str]
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.
    regex Property Map
    The regular expressions to match the response content with.
    successStatusCodes List<String>
    The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.

    RestResponseResponseRegex

    MatchQuantifier string
    Indicates whether any or all of the expressions should match with the response content.
    Matches List<string>
    The list of regular expressions.
    MatchQuantifier string
    Indicates whether any or all of the expressions should match with the response content.
    Matches []string
    The list of regular expressions.
    matchQuantifier String
    Indicates whether any or all of the expressions should match with the response content.
    matches List<String>
    The list of regular expressions.
    matchQuantifier string
    Indicates whether any or all of the expressions should match with the response content.
    matches string[]
    The list of regular expressions.
    match_quantifier str
    Indicates whether any or all of the expressions should match with the response content.
    matches Sequence[str]
    The list of regular expressions.
    matchQuantifier String
    Indicates whether any or all of the expressions should match with the response content.
    matches List<String>
    The list of regular expressions.

    RolloutIdentityAuthenticationResponse

    WaitStepAttributesResponse

    Duration string
    The duration in ISO 8601 format of how long the wait should be.
    Duration string
    The duration in ISO 8601 format of how long the wait should be.
    duration String
    The duration in ISO 8601 format of how long the wait should be.
    duration string
    The duration in ISO 8601 format of how long the wait should be.
    duration str
    The duration in ISO 8601 format of how long the wait should be.
    duration String
    The duration in ISO 8601 format of how long the wait should be.

    WaitStepPropertiesResponse

    attributes Property Map
    The Wait attributes

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native