getEntity

Describes the result of the request to view entities. API Version: 2020-05-01.

Using getEntity

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 getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
def get_entity(filter: Optional[str] = None,
               group_name: Optional[str] = None,
               search: Optional[str] = None,
               select: Optional[str] = None,
               skip: Optional[int] = None,
               skiptoken: Optional[str] = None,
               top: Optional[int] = None,
               view: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEntityResult
def get_entity_output(filter: Optional[pulumi.Input[str]] = None,
               group_name: Optional[pulumi.Input[str]] = None,
               search: Optional[pulumi.Input[str]] = None,
               select: Optional[pulumi.Input[str]] = None,
               skip: Optional[pulumi.Input[int]] = None,
               skiptoken: Optional[pulumi.Input[str]] = None,
               top: Optional[pulumi.Input[int]] = None,
               view: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
func GetEntity(ctx *Context, args *GetEntityArgs, opts ...InvokeOption) (*GetEntityResult, error)
func GetEntityOutput(ctx *Context, args *GetEntityOutputArgs, opts ...InvokeOption) GetEntityResultOutput

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

public static class GetEntity 
{
    public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:management:getEntity
  arguments:
    # arguments dictionary

The following arguments are supported:

Filter string

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

GroupName string

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

Search string

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

Select string

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

Skip int

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

Skiptoken string

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

Top int

Number of elements to return when retrieving results. Passing this in will override $skipToken.

View string

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

Filter string

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

GroupName string

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

Search string

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

Select string

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

Skip int

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

Skiptoken string

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

Top int

Number of elements to return when retrieving results. Passing this in will override $skipToken.

View string

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

filter String

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

groupName String

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

search String

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

select String

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

skip Integer

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

skiptoken String

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

top Integer

Number of elements to return when retrieving results. Passing this in will override $skipToken.

view String

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

filter string

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

groupName string

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

search string

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

select string

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

skip number

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

skiptoken string

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

top number

Number of elements to return when retrieving results. Passing this in will override $skipToken.

view string

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

filter str

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

group_name str

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

search str

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

select str

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

skip int

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

skiptoken str

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

top int

Number of elements to return when retrieving results. Passing this in will override $skipToken.

view str

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

filter String

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

groupName String

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

search String

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

select String

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

skip Number

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

skiptoken String

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

top Number

Number of elements to return when retrieving results. Passing this in will override $skipToken.

view String

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

getEntity Result

The following output properties are available:

Count int

Total count of records that match the filter

NextLink string

The URL to use for getting the next set of results.

Value List<Pulumi.AzureNative.Management.Outputs.EntityInfoResponse>

The list of entities.

Count int

Total count of records that match the filter

NextLink string

The URL to use for getting the next set of results.

Value []EntityInfoResponse

The list of entities.

count Integer

Total count of records that match the filter

nextLink String

The URL to use for getting the next set of results.

value List<EntityInfoResponse>

The list of entities.

count number

Total count of records that match the filter

nextLink string

The URL to use for getting the next set of results.

value EntityInfoResponse[]

The list of entities.

count int

Total count of records that match the filter

next_link str

The URL to use for getting the next set of results.

value Sequence[EntityInfoResponse]

The list of entities.

count Number

Total count of records that match the filter

nextLink String

The URL to use for getting the next set of results.

value List<Property Map>

The list of entities.

Supporting Types

EntityInfoResponse

Id string

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

Name string

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

Type string

The type of the resource. For example, Microsoft.Management/managementGroups

DisplayName string

The friendly name of the management group.

InheritedPermissions string

The users specific permissions to this item.

NumberOfChildGroups int

Number of children is the number of Groups that are exactly one level underneath the current Group.

NumberOfChildren int

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

NumberOfDescendants int
Parent Pulumi.AzureNative.Management.Inputs.EntityParentGroupInfoResponse

(Optional) The ID of the parent management group.

ParentDisplayNameChain List<string>

The parent display name chain from the root group to the immediate parent

ParentNameChain List<string>

The parent name chain from the root group to the immediate parent

Permissions string

The users specific permissions to this item.

TenantId string

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

Id string

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

Name string

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

Type string

The type of the resource. For example, Microsoft.Management/managementGroups

DisplayName string

The friendly name of the management group.

InheritedPermissions string

The users specific permissions to this item.

NumberOfChildGroups int

Number of children is the number of Groups that are exactly one level underneath the current Group.

NumberOfChildren int

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

NumberOfDescendants int
Parent EntityParentGroupInfoResponse

(Optional) The ID of the parent management group.

ParentDisplayNameChain []string

The parent display name chain from the root group to the immediate parent

ParentNameChain []string

The parent name chain from the root group to the immediate parent

Permissions string

The users specific permissions to this item.

TenantId string

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

id String

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

name String

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

type String

The type of the resource. For example, Microsoft.Management/managementGroups

displayName String

The friendly name of the management group.

inheritedPermissions String

The users specific permissions to this item.

numberOfChildGroups Integer

Number of children is the number of Groups that are exactly one level underneath the current Group.

numberOfChildren Integer

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

numberOfDescendants Integer
parent EntityParentGroupInfoResponse

(Optional) The ID of the parent management group.

parentDisplayNameChain List<String>

The parent display name chain from the root group to the immediate parent

parentNameChain List<String>

The parent name chain from the root group to the immediate parent

permissions String

The users specific permissions to this item.

tenantId String

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

id string

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

name string

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

type string

The type of the resource. For example, Microsoft.Management/managementGroups

displayName string

The friendly name of the management group.

inheritedPermissions string

The users specific permissions to this item.

numberOfChildGroups number

Number of children is the number of Groups that are exactly one level underneath the current Group.

numberOfChildren number

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

numberOfDescendants number
parent EntityParentGroupInfoResponse

(Optional) The ID of the parent management group.

parentDisplayNameChain string[]

The parent display name chain from the root group to the immediate parent

parentNameChain string[]

The parent name chain from the root group to the immediate parent

permissions string

The users specific permissions to this item.

tenantId string

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

id str

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

name str

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

type str

The type of the resource. For example, Microsoft.Management/managementGroups

display_name str

The friendly name of the management group.

inherited_permissions str

The users specific permissions to this item.

number_of_child_groups int

Number of children is the number of Groups that are exactly one level underneath the current Group.

number_of_children int

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

number_of_descendants int
parent EntityParentGroupInfoResponse

(Optional) The ID of the parent management group.

parent_display_name_chain Sequence[str]

The parent display name chain from the root group to the immediate parent

parent_name_chain Sequence[str]

The parent name chain from the root group to the immediate parent

permissions str

The users specific permissions to this item.

tenant_id str

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

id String

The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

name String

The name of the entity. For example, 00000000-0000-0000-0000-000000000000

type String

The type of the resource. For example, Microsoft.Management/managementGroups

displayName String

The friendly name of the management group.

inheritedPermissions String

The users specific permissions to this item.

numberOfChildGroups Number

Number of children is the number of Groups that are exactly one level underneath the current Group.

numberOfChildren Number

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

numberOfDescendants Number
parent Property Map

(Optional) The ID of the parent management group.

parentDisplayNameChain List<String>

The parent display name chain from the root group to the immediate parent

parentNameChain List<String>

The parent name chain from the root group to the immediate parent

permissions String

The users specific permissions to this item.

tenantId String

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000

EntityParentGroupInfoResponse

Id string

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

Id string

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

id String

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

id string

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

id str

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

id String

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0