Public/Metadata.txt

 
#GetAllAttributesForEntity
function Get-CrmEntityAttributes{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName
    )
 
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
        
    try
    {
        $result = $conn.GetAllAttributesForEntity($EntityLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
 
    return $result
}
 
#GetAllEntityMetadata
function Get-CrmEntityAllMetadata{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$false, Position=1)]
        [bool]$OnlyPublished=$true,
        [parameter(Mandatory=$false, Position=2)]
        [string]$EntityFilters
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    switch($EntityFilters.ToLower())
    {
        "all" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::All
            break
        }
        "attributes" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Attributes
            break
        }
        "entity" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Entity
            break
        }
        "privileges" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Privileges
            break
        }
        "relationships" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Relationships
            break
        }
        default {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Default
            break
        }
    }
    try
    {
        $result = $conn.GetAllEntityMetadata($OnlyPublished, $filter)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
#GetEntityAttributeMetadataForAttribute
function Get-CrmEntityAttributeMetadata{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName,
        [parameter(Mandatory=$true, Position=2)]
        [string]$FieldLogicalName
    )
 
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
     
    try
    {
        $result = $conn.GetEntityAttributeMetadataForAttribute($EntityLogicalName, $FieldLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
 
#GetEntityDisplayName
function Get-CrmEntityDisplayName{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1, ParameterSetName="EntityLogicalName")]
        [string]$EntityLogicalName
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    try
    {
        $result = $conn.GetEntityDisplayName($EntityLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
#GetEntityDisplayNamePlural
function Get-CrmEntityDisplayPluralName{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    try
    {
        $result = $conn.GetEntityDisplayNamePlural($EntityLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
#GetEntityMetadata
function Get-CrmEntityMetadata{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName,
        [parameter(Mandatory=$false, Position=2)]
        [string]$EntityFilters
    )
 
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
 
    switch($EntityFilters.ToLower())
    {
        "all" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::All
            break
        }
        "attributes" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Attributes
            break
        }
        "entity" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Entity
            break
        }
        "privileges" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Privileges
            break
        }
        "relationships" {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Relationships
            break
        }
        default {
            $filter = [Microsoft.Xrm.Sdk.Metadata.EntityFilters]::Default
            break
        }
    }
 
    try
    {
        $result = $conn.GetEntityMetadata($EntityLogicalName, $filter)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
 
    return $result
}
 
#GetEntityName
function Get-CrmEntityName{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [int]$EntityTypeCode
    )
 
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
 
    try
    {
        $result = $conn.GetEntityName($EntityTypeCode)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
 
    return $result
}
 
#GetEntityTypeCode
function Get-CrmEntityTypeCode{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    try
    {
        $result = $conn.GetEntityTypeCode($EntityLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
#GetGlobalOptionSetMetadata
function Get-CrmGlobalOptionSet{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$OptionSetName
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    try
    {
        $result = $conn.GetGlobalOptionSetMetadata($OptionSetName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
    return $result
}
 
#GetPickListElementFromMetadataEntity
function Get-CrmEntityOptionSet{
# .ExternalHelp Campgemini.Xrm.Data.PowerShell.Help.xml
 [CmdletBinding()]
    PARAM(
        [parameter(Mandatory=$false)]
        [Microsoft.Xrm.Sdk.IOrganizationService]$conn,
        [parameter(Mandatory=$true, Position=1)]
        [string]$EntityLogicalName,
        [parameter(Mandatory=$true, Position=2)]
        [string]$FieldLogicalName
    )
    $conn = VerifyCrmConnectionParam -conn $conn -pipelineValue ($PSBoundParameters.ContainsKey('conn'))
    try
    {
        $result = $conn.GetPickListElementFromMetadataEntity($EntityLogicalName, $FieldLogicalName)
        if($result -eq $null)
        {
            throw $_.Exception
        }
    }
    catch
    {
        throw $_.Exception
    }
 
    return $result
}