Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cloudhealth
  5. getRelationship
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.6.1 published on Friday, Aug 1, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cloudhealth.getRelationship

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.6.1 published on Friday, Aug 1, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a Relationship

    Uses Azure REST API version 2025-05-01-preview.

    Using getRelationship

    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 getRelationship(args: GetRelationshipArgs, opts?: InvokeOptions): Promise<GetRelationshipResult>
function getRelationshipOutput(args: GetRelationshipOutputArgs, opts?: InvokeOptions): Output<GetRelationshipResult>
    def get_relationship(health_model_name: Optional[str] = None,
                     relationship_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRelationshipResult
def get_relationship_output(health_model_name: Optional[pulumi.Input[str]] = None,
                     relationship_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRelationshipResult]
    func LookupRelationship(ctx *Context, args *LookupRelationshipArgs, opts ...InvokeOption) (*LookupRelationshipResult, error)
func LookupRelationshipOutput(ctx *Context, args *LookupRelationshipOutputArgs, opts ...InvokeOption) LookupRelationshipResultOutput

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

    public static class GetRelationship 
{
    public static Task<GetRelationshipResult> InvokeAsync(GetRelationshipArgs args, InvokeOptions? opts = null)
    public static Output<GetRelationshipResult> Invoke(GetRelationshipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRelationshipResult> getRelationship(GetRelationshipArgs args, InvokeOptions options)
public static Output<GetRelationshipResult> getRelationship(GetRelationshipArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cloudhealth:getRelationship
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HealthModelName string
    Name of health model resource
    RelationshipName string
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    HealthModelName string
    Name of health model resource
    RelationshipName string
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    healthModelName String
    Name of health model resource
    relationshipName String
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    healthModelName string
    Name of health model resource
    relationshipName string
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    health_model_name str
    Name of health model resource
    relationship_name str
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    healthModelName String
    Name of health model resource
    relationshipName String
    Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getRelationship Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.CloudHealth.Outputs.RelationshipPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.CloudHealth.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties RelationshipPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties RelationshipPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties RelationshipPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties RelationshipPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    RelationshipPropertiesResponse

    ChildEntityName string
    Resource name of the child entity
    DeletionDate string
    Date when the relationship was (soft-)deleted
    DiscoveredBy string
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    ParentEntityName string
    Resource name of the parent entity
    ProvisioningState string
    The status of the last operation.
    DisplayName string
    Display name
    Labels Dictionary<string, string>
    Optional set of labels (key-value pairs)
    ChildEntityName string
    Resource name of the child entity
    DeletionDate string
    Date when the relationship was (soft-)deleted
    DiscoveredBy string
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    ParentEntityName string
    Resource name of the parent entity
    ProvisioningState string
    The status of the last operation.
    DisplayName string
    Display name
    Labels map[string]string
    Optional set of labels (key-value pairs)
    childEntityName String
    Resource name of the child entity
    deletionDate String
    Date when the relationship was (soft-)deleted
    discoveredBy String
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    parentEntityName String
    Resource name of the parent entity
    provisioningState String
    The status of the last operation.
    displayName String
    Display name
    labels Map<String,String>
    Optional set of labels (key-value pairs)
    childEntityName string
    Resource name of the child entity
    deletionDate string
    Date when the relationship was (soft-)deleted
    discoveredBy string
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    parentEntityName string
    Resource name of the parent entity
    provisioningState string
    The status of the last operation.
    displayName string
    Display name
    labels {[key: string]: string}
    Optional set of labels (key-value pairs)
    child_entity_name str
    Resource name of the child entity
    deletion_date str
    Date when the relationship was (soft-)deleted
    discovered_by str
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    parent_entity_name str
    Resource name of the parent entity
    provisioning_state str
    The status of the last operation.
    display_name str
    Display name
    labels Mapping[str, str]
    Optional set of labels (key-value pairs)
    childEntityName String
    Resource name of the child entity
    deletionDate String
    Date when the relationship was (soft-)deleted
    discoveredBy String
    Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
    parentEntityName String
    Resource name of the parent entity
    provisioningState String
    The status of the last operation.
    displayName String
    Display name
    labels Map<String>
    Optional set of labels (key-value pairs)

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.6.1 published on Friday, Aug 1, 2025 by Pulumi
    pulumi/pulumi-azure-native